VCOM:VectorWorks:IFCLib:IIFCSupport::IFC IsFieldOptional

.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 IIFCSupport

Checks whether the specified object's field is Optional.

VCOMError IFC_IsFieldOptional(
                const TXString&   strObjectName,
                const TXString&   strEntryName,
                const TXString&   strFieldName,
                const TXString&   strPSetName = "");

Parameters

strObjectName		TXString		Object name.
strEntryName		TXString		IFC Entity name.
strFieldName		TXString		Field name.
strPSetName		TXString		Property Set name. Optional parameter used only when the field is a part of a Property Set.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NoError		The Field is Optional.
kVCOMError_False		The Field is NOT Optional.
kVCOMError_Failed		Routine failed.

Remarks

Use this function via global pointer gIFC.

Version

Available from: Vectorworks 2019.