Hide Table of Contents
SetVar Method (IEdmTaskInstance)

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

Syntax

Visual Basic (Declaration) 
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

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 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.

Return codes:

  • S_OK: The method successfully executed.
 

See Also

Availability

SOLIDWORKS PDM Professional 2010


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SetVar Method (IEdmTaskInstance)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2023 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.