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

From Vectorworks Developer
Jump to: navigation, search
Line 9: Line 9:
 
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport|IIFCSupport]]
 
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport|IIFCSupport]]
  
...put some description here...
+
Returns on of three paramters of a space object (Space name/Space Type/Space Number) in which the specified object is confined or adjoined.
 
</desc>
 
</desc>
  
Line 25: Line 25:
 
hObject
 
hObject
 
MCObjectHandle
 
MCObjectHandle
no info.
+
Handle to object.
 
</line>
 
</line>
 
<line>
 
<line>
 
param
 
param
 
TXString
 
TXString
no info.
+
Index that determines the return parameter for the space object. The Possible values are: <b>1</b> (Space Type), <b>2</b> (Space Name) and <b>3</b> (Space Number).
 
</line>
 
</line>
 
<line>
 
<line>
 
outResult
 
outResult
 
TXString
 
TXString
no info.
+
The return value of the parameter.  
 
</line>
 
</line>
 
</lineList>
 
</lineList>
Line 49: Line 49:
 
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 63: Line 59:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<remark>
 
<remark>
 +
Please note that if the object is not situated in a space object the routine is going to fail.
 +
Please note that if the object is situated in more than one space objects and the parameters in more that one of them return a value, they will be listed consecutively separated by a coma (',').
 +
 +
 
Use this function via global pointer gIFC.  
 
Use this function via global pointer gIFC.  
 
</remark>  
 
</remark>  
Line 76: Line 76:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<version>
 
<version>
 +
Available since: Vectorworks 2018.
 
</version>
 
</version>
  

Revision as of 07:10, 27 August 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 IIFCSupport

Returns on of three paramters of a space object (Space name/Space Type/Space Number) in which the specified object is confined or adjoined.

VCOMError IFC_GetSpaceParamForObject2(
MCObjectHandle hObject,
const TXString& param,
TXString& outResult);

Parameters

hObject MCObjectHandle Handle to object.
param TXString Index that determines the return parameter for the space object. The Possible values are: 1 (Space Type), 2 (Space Name) and 3 (Space Number).
outResult TXString The return value of the parameter.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

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

Remarks

Please note that if the object is not situated in a space object the routine is going to fail.

Please note that if the object is situated in more than one space objects and the parameters in more that one of them return a value, they will be listed consecutively separated by a coma (',').


Use this function via global pointer gIFC.

Version

Available since: Vectorworks 2018.
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox