VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetParamStyle: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]]
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]]


...put some description here...
Returns the style of the parameter. The style modes are:
</desc>
</desc>


Line 25: Line 25:
hFormat
hFormat
MCObjectHandle
MCObjectHandle
no info.
Handle to the record or to format.
</line>
</line>
<line>
<line>
paramIndex
paramIndex
size_t
size_t
no info.
Index of the field.
</line>
</line>
<line>
<line>
outFieldStyle
outFieldStyle
EFieldStyle
EFieldStyle
no info.
Field style. Possible values are: kFieldLongInt = 1, kFieldBoolean = 2, kFieldReal = 3, kFieldText = 4, kFieldCalculation = 5, kFieldHandle = 6, kFieldCoordDisp = 7, kFieldPopUp = 8, kFieldRadio = 9, kFieldCoordLocX = 10, kFieldCoordLocY = 11, kFieldStaticText = 14, kFieldControlPoint = 15, kFieldDimStdPopUp = 16, kFieldPrecisionPopUp = 17, kFieldClassesPopup = 18, kFieldLayersPopup = 19, kFieldAngle = 20, kFieldArea = 21, kFieldVolume = 22
</listTable>
</line>
</line>
<line>
<line>
recType
recType
ERecordIFCType
ERecordIFCType
no info.
The type of the record. Possible values are: ERecordIFCType::None, ERecordIFCType::IFC, ERecordIFCType::PSet, ERecordIFCType::IFCTag.
</line>
</line>
</lineList>
</lineList>
Line 54: Line 55:
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>
Line 81: Line 78:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<version>
<version>
Available from Vectorworks 2019.
Available from: Vectorworks 2019.
</version>
</version>



Revision as of 08:10, 12 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 style of the parameter. The style modes are:

VCOMError IFC_GetParamStyle(
MCObjectHandle hFormat,
size_t paramIndex,
EFieldStyle& outFieldStyle,
ERecordIFCType recType = ERecordIFCType::None);

Parameters

hFormat MCObjectHandle Handle to the record or to format.
paramIndex size_t Index of the field.
outFieldStyle EFieldStyle Field style. Possible values are: kFieldLongInt = 1, kFieldBoolean = 2, kFieldReal = 3, kFieldText = 4, kFieldCalculation = 5, kFieldHandle = 6, kFieldCoordDisp = 7, kFieldPopUp = 8, kFieldRadio = 9, kFieldCoordLocX = 10, kFieldCoordLocY = 11, kFieldStaticText = 14, kFieldControlPoint = 15, kFieldDimStdPopUp = 16, kFieldPrecisionPopUp = 17, kFieldClassesPopup = 18, kFieldLayersPopup = 19, kFieldAngle = 20, kFieldArea = 21, kFieldVolume = 22
recType ERecordIFCType The type of the record. Possible values are: ERecordIFCType::None, ERecordIFCType::IFC, ERecordIFCType::PSet, ERecordIFCType::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.