This method works in the context of the project passed in the Connect call. The SmartPlant Foundation database is queried for an object list claimed by the tool, and an object/rel with only IObject interface is created in the oObjList container. The container contains all objects claimed by the tool in the project unless the document UID is specified. If the document UID is specified, the container contains only the objects/rels claimed in the context of the document in the project.
Signature
GetClaimedObjList (oObjList as IContainer, Optional sDocUID as String) As Long
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oObjList |
IContainer |
Output |
Pointer to the IContainer containing the claimed objects. Only the IObject interface is returned. |
|
sDocUID |
String (maximum 128 characters) |
Input |
Optional input argument, string specifying the document of which the claimed object list is being obtained. If the doc UID is not specified, then all claimed objects/rels are returned. |
Return Value
0 if the method is successful.
A negative number if the method fails. (Check LastErrorMessage property for error message)