Hide Table of Contents
GetDictionary Method (IEdmVault5)

Gets or creates the specified dictionary.

Syntax

Visual Basic (Declaration) 
Function GetDictionary( _
   ByVal bsName As System.String, _
   ByVal bCreateIfNew As System.Boolean _
) As IEdmDictionary5
C# 
IEdmDictionary5 GetDictionary( 
   System.string bsName,
   System.bool bCreateIfNew
)
C++/CLI 
IEdmDictionary5^ GetDictionary( 
&   System.String^ bsName,
&   System.bool bCreateIfNew
) 

Parameters

bsName
Name of dictionary to get or create
bCreateIfNew
True to create the dictionary if it does not exist, false to not

Return Value

IEdmDictionary5; Null if bCreateIfNew is false and the dictionary with bsName does not exist

Example

Remarks

A dictionary in SOLIDWORKS PDM Professional is a way of storing arbitrary data in the SOLIDWORKS PDM Professional database. The data is organized into key-value pairs. The values are always strings. The keys can be either integers or strings.

NOTE: If you intend to store file- or folder-specific data and want the data to be deleted or copied whenever the file or folder is deleted or copied, consider using card variables instead of dictionaries. Card variables stored using IEdmEnumeratorVariable5 do not require corresponding controls in the file or folder data card.

Return codes: 

  • S_OK: The method successfully executed.
  • S_FALSE: The dictionary with the specified name does not exist, and bCreateIfNew is false.
  • E_EDM_NOT_LOGGED_IN: You must call IEdmVault5::Login or IEdmVault5::LoginAuto before calling this method.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2


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:   GetDictionary Method (IEdmVault5)
*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) 2018 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.