| Visual Basic | |
|---|---|
Sub SetVar( _ ByVal oVarIDorName As System.Object, _ ByVal oValue As System.Object _ ) | |
| C# | |
|---|---|
void SetVar( System.object oVarIDorName, System.object oValue ) | |
| C++/CLI | |
|---|---|
void SetVar( & System.Object^ oVarIDorName, & System.Object^ oValue ) | |
Parameters
- oVarIDorName
- Database ID or name of the variable for which to set a value (see Remarks)
- oValue
- Value to set
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 task add-in can call IEdmTaskInstance::GetVar during the processing of the EdmCmdType.EdmCmd_TaskRun hook to retrieve a card variable value from the server where the task 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.
- S_OK: The method successfully executed.