Hide Table of Contents
GetVarAsText Method (IEdmEnumeratorVariable10)

Gets the value of the specified variable in text format from this file or folder.

Syntax

Visual Basic (Declaration) 
Function GetVarAsText( _
   ByVal bsVarName As System.String, _
   ByVal bsCfgName As System.String, _
   ByVal lFolderID As System.Integer, _
   ByRef poRetValue As System.Object _
) As System.Boolean
C# 
System.bool GetVarAsText( 
   System.string bsVarName,
   System.string bsCfgName,
   System.int lFolderID,
   out System.object poRetValue
)
C++/CLI 
System.bool GetVarAsText( 
&   System.String^ bsVarName,
&   System.String^ bsCfgName,
&   System.int lFolderID,
&   [Out] System.Object^ poRetValue
) 

Parameters

bsVarName
Name of variable to read
bsCfgName
Name of configuration or layout from which to get the variable value; empty string for folders and file types that do not support configurations (see Remarks)
lFolderID
ID of parent folder
poRetValue
Variable value in text format

Return Value

True if the variable is found, false if not

Remarks

To specify bsCfgName:

  • Call IEdmFile5::GetConfigurations to get the available configuration names for this file.
  • If this method is used in your add-in's implementation of IEdmAddIn5::OnCmd, then a list of configuration names for the data card is returned in ppoData that can be cast to EdmCmdData. EdmCmdData.mpoExtra contains an IEdmStrLst5 of configuration names.

C++ users must initialize the VARIANT struct of poRetValue with a call to VariantInit before calling this method. They also must free the contents of the struct with a call to VariantClear. 

Return codes:

  • S_OK: The method successfully executed.
  • S_FALSE: The variable was not found. 
 

See Also

Availability

SOLIDWORKS PDM Professional 2015 SP04


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:   GetVarAsText Method (IEdmEnumeratorVariable10)
*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) 2022 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.