Hide Table of Contents
GetVar Method (IEdmTaskInstance)

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

Syntax

Visual Basic (Declaration) 
Function GetVar( _
   ByVal oVarIDorName As System.Object _
) As System.Object
C# 
System.object GetVar( 
   System.object oVarIDorName
)
C++/CLI 
System.Object^ GetVar( 
&   System.Object^ oVarIDorName
) 

Parameters

oVarIDorName
ID or name of the card variable for which to get a value

Return Value

Value of a card variable

Remarks

The task add-in calls this method while the task is running on the server (EdmCmdType.EdmCmd_TaskRun) to retrieve a variable value set by the add-in when it calls: 

  • IEdmTaskInstance::SetVar during the processing of the EdmCmdType.EdmCmd_TaskLaunch hook when the user enters values on the data card displayed when the task is launched on the client computer.
  • IEdmTaskProperties.SetVar during the processing of the EdmCmdType.EdmCmd_TaskSetup hook when the user enters data card variable values on the task setup page.

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

Return codes:

  • S_OK: The method successfully executed.
 

See Also

Availability

SolidWorks Enterprise PDM 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:   GetVar 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) 2014 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.