VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetParamName: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{LocationMain|category=LocationVCOM|specific=}} __TOC__ <vwDoc> ----------------------------------------------------------------------------------------------------------- <...") |
No edit summary |
||
Line 9: | Line 9: | ||
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]] | Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]] | ||
Returns the parameter name. | |||
</desc> | </desc> | ||
Line 25: | Line 25: | ||
hFormat | hFormat | ||
MCObjectHandle | MCObjectHandle | ||
Handle to the format record. | |||
</line> | </line> | ||
<line> | <line> | ||
paramIndex | paramIndex | ||
size_t | size_t | ||
Parameter index. | |||
<line> | <line> | ||
outParamName | outParamName | ||
TXString& | TXString& | ||
Out parameter for the result. | |||
</line> | </line> | ||
<line> | <line> | ||
recType | recType | ||
ERecordIFCType | ERecordIFCType | ||
Record type, possible values are: None, IFC, PSet, IFCTag. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
Line 53: | Line 53: | ||
kVCOMError_NoError | kVCOMError_NoError | ||
The function succeeded. No Error! | The function succeeded. No Error! | ||
</line> | </line> | ||
<line> | <line> |
Revision as of 07:01, 16 February 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 name.
VCOMError IFC_GetParamName(
MCObjectHandle hFormat,
size_t paramIndex,
TXString& outParamName,
ERecordIFCType recType = ERecordIFCType::None);
Parameters
hFormat MCObjectHandle Handle to the format record. paramIndex size_t Parameter index. 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.