Hide Table of Contents
Get6 Method (ICustomPropertyManager)

Gets the value and the evaluated value of the specified custom property.

.NET Syntax

Visual Basic (Declaration) 
Function Get6( _
   ByVal FieldName As System.String, _
   ByVal UseCached As System.Boolean, _
   ByRef ValOut As System.String, _
   ByRef ResolvedValOut As System.String, _
   ByRef WasResolved As System.Boolean, _
   ByRef LinkToProperty As System.Boolean _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ICustomPropertyManager
Dim FieldName As System.String
Dim UseCached As System.Boolean
Dim ValOut As System.String
Dim ResolvedValOut As System.String
Dim WasResolved As System.Boolean
Dim LinkToProperty As System.Boolean
Dim value As System.Integer
 
value = instance.Get6(FieldName, UseCached, ValOut, ResolvedValOut, WasResolved, LinkToProperty)
C# 
System.int Get6( 
   System.string FieldName,
   System.bool UseCached,
   out System.string ValOut,
   out System.string ResolvedValOut,
   out System.bool WasResolved,
   out System.bool LinkToProperty
)
C++/CLI 
System.int Get6( 
&   System.String^ FieldName,
&   System.bool UseCached,
&   [Out] System.String^ ValOut,
&   [Out] System.String^ ResolvedValOut,
&   [Out] System.bool WasResolved,
&   [Out] System.bool LinkToProperty
) 

Parameters

FieldName
Name of the custom property
UseCached
True if the configuration has been activated, false if not (see Remarks)
ValOut
Value of the custom property
ResolvedValOut
Evaluated value of the custom property
WasResolved
True if the value was evaluated, false if not (see Remarks)
LinkToProperty
True to link FieldName to its parent part, false to not

Return Value

Result code as defined in swCustomInfoGetResult_e

Example

See the Get Custom Properties for Configuration examples in ICustomPropertyManager.

Remarks

This method returns configuration-specific, linked, and evaluated custom-property data more quickly than the now obsolete ICustomPropertyManager::Get2, if the configuration is previously activated.

This method gets the cached custom property, even if its configuration is not currently active.



If UseCached is set to...

And the configuration has already been activated...



Then...

True

Yes

Up-to-date data is returned and WasResolved = true

True

No

Cached data is returned and WasResolved = false

False

Yes

Up-to-date data is returned and WasResolved = true

False

No

Up-to-date data is returned and WasResolved = true

 

If you always want up-to-date data, then you should set UseCached to false.

If the configuration is not previously activated, this method might take longer, as it loops through all of the model's configurations to find the specified custom property. When it finishes, the model might not be in its original configuration. To return the model to its original configuration, call IModelDoc2::ForceRebuild3 after calling this method.

This method does not preface the resolved evaluated values of external referenced documents with fromparent+, unlike the now obsolete ICustomPropertyManager::Get3.

 

See Also

Availability

SOLIDWORKS 2018 FCS, Revision Number 26.0


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:   Get6 Method (ICustomPropertyManager)
*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.