Difference between revisions of "VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetParamValue"

From Vectorworks Developer
Jump to: navigation, search
Line 9: Line 9:
 
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]]
 
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]]
  
...put some description here...
+
Returns the parameter value.  
 
</desc>
 
</desc>
  
Line 25: Line 25:
 
hFormat
 
hFormat
 
MCObjectHandle
 
MCObjectHandle
no info.
+
Handle to the format record.
 
</line>
 
</line>
 
<line>
 
<line>
 
paramIndex
 
paramIndex
 
size_t
 
size_t
no info.
+
Parameter index.
 
</line>
 
</line>
 
<line>
 
<line>
 
outParamValue
 
outParamValue
 
TXString
 
TXString
no info.
+
Out parameter for the result.
 
</line>
 
</line>
 
<line>
 
<line>
 
recType  
 
recType  
 
ERecordIFCType
 
ERecordIFCType
no info.
+
Record type, possible values are: None, IFC, PSet, IFCTag.
 
</line>
 
</line>
 
</lineList>
 
</lineList>
Line 54: Line 54:
 
kVCOMError_NoError
 
kVCOMError_NoError
 
The function succeeded. No Error!
 
The function succeeded. No Error!
</line>
 
<line>
 
kVCOMError_NotInitialized
 
Bad VCOM instance used to call the function.
 
 
</line>
 
</line>
 
<line>
 
<line>

Revision as of 03:04, 26 March 2018

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::IFCLib

Member of VCOM:VectorWorks:IFCLib:IIFCSupport

Returns the parameter value.

VCOMError IFC_GetParamValue(
MCObjectHandle hFormat,
size_t paramIndex,
TXString& outParamValue,
ERecordIFCType recType = ERecordIFCType::None);

Parameters

hFormat MCObjectHandle Handle to the format record.
paramIndex size_t Parameter index.
outParamValue TXString Out parameter for the result.
recType ERecordIFCType Record type, possible values are: None, IFC, PSet, IFCTag.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NoError The function succeeded. No Error!
kVCOMError_Failed Routine failed.

Remarks

Use this function via global pointer gIFC.

Version

Available from: Vectorworks 2019.
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox