<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
SetVar Method (IEdmTaskProperties)
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 > IEdmTaskProperties Interface : SetVar Method (IEdmTaskProperties)

Visual Basic
C#
C++/CLI

lVarID
  ID of the variable for which to set a value (see Remarks)

oValue
  Value to set

Sets the value of a card variable created in the administration tool.

# Syntax

Visual Basic |
--- | ---

    Sub SetVar( _
       ByVal lVarID As System.Integer, _
       ByVal oValue As System.Object _
    )

C# |
--- | ---

    void SetVar(
       System.int lVarID,
       System.object oValue
    )

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

    void SetVar(
    &   System.int lVarID,
    &   System.Object^ oValue
    )

#### Parameters

lVarID
  ID of the variable for which to set a value (see Remarks)
oValue
  Value to set

# Remarks

The task add-in can display a data card with variable values that the user can modify when the task is launched on the client computer (EdmCmdType.EdmCmd_TaskLaunch). The add-in can call this method to store the variable values entered by the user.

The card variable value set by this method can be retrieved by calling:

- IEdmTaskProperties::GetVar.
- IEdmTaskInstance::GetVar during the processing of the EdmCmdType.EdmCmd_TaskRun hook on the server where the task instance is running.

Card variables are created using the administration tool card editor and are not related to the user-defined variables accessed by IEdmTaskInstance::GetValEx and IEdmTaskInstance::SetValEx.

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

Return codes:

- S_OK: The method successfully executed.

# See Also

####

IEdmTaskProperties Interface
IEdmTaskProperties Members
Task Add-in Sample

# Availability

SOLIDWORKS PDM Professional 2010