VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetCOBieProperty: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{LocationMain|category=LocationVCOM|specific=}} __TOC__ <vwDoc> ----------------------------------------------------------------------------------------------------------- <...") |
NBeshevliev (talk | contribs) No edit summary |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
namespace <code>VectorWorks::IFCLib</code> | namespace <code>VectorWorks::IFCLib</code> | ||
Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport]] | Member of [[VCOM:VectorWorks:IFCLib:IIFCSupport|IIFCSupport]] | ||
Returns the value of a COBie property for an object. | |||
</desc> | </desc> | ||
| Line 28: | Line 28: | ||
hObject | hObject | ||
MCObjectHandle | MCObjectHandle | ||
Handle to object. | |||
</line> | </line> | ||
<line> | <line> | ||
worksheetName | worksheetName | ||
TXString | TXString | ||
Name of the worksheet. | |||
</line> | </line> | ||
<line> | <line> | ||
columnName | columnName | ||
TXString | TXString | ||
Name of the column in the worksheet. | |||
</line> | </line> | ||
<line> | <line> | ||
country | country | ||
TXString | TXString | ||
COBie version based on country of origin. Optional parameter. Default value: "US". | |||
</line> | </line> | ||
<line> | <line> | ||
version | version | ||
TXString | TXString | ||
COBie version based on the standard version. Optional parameter. Default value: "2.4". | |||
</line> | </line> | ||
<line> | <line> | ||
argStrings | argStrings | ||
TXString | TXString | ||
The worksheetName, columnName, version and country strings all filled into one string divided by ".". Version and country are also optional for this parameter. | |||
</line> | </line> | ||
<line> | <line> | ||
outResult | outResult | ||
TXString | TXString | ||
Returned string. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 86: | Line 86: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark> | <remark> | ||
This function is usually used with COBie worksheet function GetCOBieProperty(criteria). The criteria is a string with two elements separated by a period. An example of the worksheet function is at it follows: =GETCOBIEPROPERTY ('space.floorname') The first element the name of the COBie worksheet and the second element is the name of the column in that worksheet. This example will return the FloorName value for objects whose COBie property is Space. | |||
Please note that the version and country strings are not mandatory and can be left empty. They ensure that any new version in the COBie standard can easily be implemented in future Vectorworks releases. As of Vectorworks 2019, they do not affect the outResult. | |||
Use this function via global pointer gIFC. | Use this function via global pointer gIFC. | ||
</remark> | </remark> | ||
| Line 95: | Line 100: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<seeAlso> | <seeAlso> | ||
[[VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetCOBieSource|IFC_GetCOBieSource]] | |||
</seeAlso> | </seeAlso> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<version> | <version> | ||
Available from: Vectorworks 2018. | |||
</version> | </version> | ||
</vwDoc> | </vwDoc> | ||
[[Category:VCOM:VectorWorks: | [[Category:VCOM:VectorWorks:IFCLib:IIFCSupport|IFC_GetCOBieProperty]] | ||
Latest revision as of 15:19, 19 June 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 the value of a COBie property for an object.
VCOMError IFC_GetCOBieProperty(
MCObjectHandle hObject,
const TXString& worksheetName,
const TXString& columnName,
const TXString& country,
const TXString& version,
TXString& outResult);
VCOMError IFC_GetCOBieProperty(
MCObjectHandle hObject,
const TXString& argStrings,
TXString& outResult);
Parameters
hObject MCObjectHandle Handle to object. worksheetName TXString Name of the worksheet. columnName TXString Name of the column in the worksheet. country TXString COBie version based on country of origin. Optional parameter. Default value: "US". version TXString COBie version based on the standard version. Optional parameter. Default value: "2.4". argStrings TXString The worksheetName, columnName, version and country strings all filled into one string divided by ".". Version and country are also optional for this parameter. outResult TXString Returned string.
Return Value
Uses standard VCOM Error Reporting.
Return value meaning:
kVCOMError_NoError The function succeeded. No Error! kVCOMError_NotInitialized Bad VCOM instance used to call the function. kVCOMError_Failed Routine failed.
Remarks
This function is usually used with COBie worksheet function GetCOBieProperty(criteria). The criteria is a string with two elements separated by a period. An example of the worksheet function is at it follows: =GETCOBIEPROPERTY ('space.floorname') The first element the name of the COBie worksheet and the second element is the name of the column in that worksheet. This example will return the FloorName value for objects whose COBie property is Space.
Please note that the version and country strings are not mandatory and can be left empty. They ensure that any new version in the COBie standard can easily be implemented in future Vectorworks releases. As of Vectorworks 2019, they do not affect the outResult.
Use this function via global pointer gIFC.
Version
Available from: Vectorworks 2018.
See Also
[[VCOM:VectorWorks:IFCLib:IIFCSupport::IFC GetCOBieSource|IFC_GetCOBieSource]]