GetPublishedObjList 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)

This method works in the context of the AsBuilt plant or a project passed in the Connect call. The SmartPlant Foundation database is queried for an object list published by the tool, and an object/rel with only IObject interface is created in the oObjList container. The container contains all objects published by the tool unless the document UID is specified. If the document UID is specified, the container contains only the objects/rels published with document.

Signature

GetPublishedObjList (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 objects. Only the IObject interface is returned.

sDocUID

String (maximum 128 characters)

Input

Optional input argument, string specifying the document of which the object list is being obtained. If the doc UID is not specified, then all published 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.)