GetObjectStatiInTool Method - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

Description

Each call that is made to GetObjectStatiInTool will identify the number of objects (lNoObjs) and the UID for the class definition (sClassUID) that applies to all of the missing objects for that method call. The UIDs and Names of the missing objects for that class are passed in the zero-based arrays (sObjUIDs and sObjNames). The adapter should return the object status for each of these objects in the eObjectStati array. If any of the objects have been given new UIDs, then the new UID(s) should be returned in the appropriate position(s) in the sNewUIDs array.

All missing objects for the same class will be passed in one call to the adapter. Therefore, there will be as many calls made to this method as there are different classes that have one or more missing objects.

Arguments

Name

Data type

Input/output

Description

INoObjs

Integer

Number of objects.

sClassUID

String

UID for the class definition.

sObjUIDs()

String

Zero-based array with UIDs for each of the missing objects.

sObjNames()

String

Zero-based array with Names for each of the missing objects.

eObjectStati()

ObjectStatusInTool

Zero-based array with object status for each of the missing objects. Set by the tool adapter.

sNewUIDs()

String

Zero-based array with new UIDs for missing objects. Only set if missing object has a new UID. Set by the tool adapter.

Comments

If an adapter does not support the IEFAdapterArray interface, then the GetObjectStatusInTool and GetRelationshipStatusInTool methods are called for each missing object and relationship.