<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
SetValEx Method (IEdmTaskInstance)
See Also

Collapse All Expand All Language Filter: All Language Filter: Multiple Language Filter: Visual Basic Language Filter: C# Language Filter: C++/CLI

EPDM.Interop.epdm Namespace > IEdmTaskInstance Interface : SetValEx Method (IEdmTaskInstance)

Visual Basic
C#
C++/CLI

bsValName
  User-defined variable name

oValue
  Value of user-defined variable (see Remarks)

Sets a value for the specified user-defined variable.

# Syntax

Visual Basic |
--- | ---

    Sub SetValEx( _
       ByVal bsValName As System.String, _
       ByVal oValue As System.Object _
    )

C# |
--- | ---

    void SetValEx(
       System.string bsValName,
       System.object oValue
    )

C++/CLI |
--- | ---

    void SetValEx(
    &   System.String^ bsValName,
    &   System.Object^ oValue
    )

#### Parameters

bsValName
  User-defined variable name
oValue
  Value of user-defined variable (see Remarks)

# Remarks

This method can be called to set the value when the task is launched on the client computer (EdmCmdType.EdmCmd_TaskLaunch) and IEdmTaskInstance::GetValEx can be called to get the value when the task is executed on the server (EdmCmdType.EdmCmd_TaskRun).

Custom data types and objects must be serialized to a string, numeric type, or date before calling IEdmTaskInstance::SetValEx. For example:

1. Serialize the object data to XML or JSON using StringBuilder, XmlWriter, XmlSerializer, etc.
2. Call IEdmTaskInstance::SetValEx to store the resulting string.
3. Call IEdmTaskInstance::GetValEx to retrieve the stored string.
4. Initialize the new instance of the object from XML/JSON using StringReader, XmlReader, XmlSerializer, etc.

NOTE: The difference between this method and IEdmTaskInstance::SetVar is that the latter requires a pre-defined card variable in the vault, whereas this method does not.

Return codes:

- S_OK: The method successfully executed.

# See Also

####

IEdmTaskInstance Interface
IEdmTaskInstance Members
Task Add-in Sample

# Availability

SOLIDWORKS PDM Professional 2010