GetPublishedDocList 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 a document list published by the tool, a document object is created in the oDocList container, and a version object is created in the oDocMeta container for each document. The version object has the revision, version and published date values.

Signature

GetPublishedDocList (oDocList as IContainer, oDocMeta as IContainer, Optional sDocTypeUID as String) As Long

Arguments

Name

Data type

Input/output

Description

oDocList

IContainer

Output

Pointer to the IContainer containing the document objects.

oDocMeta

IContainer

Output

Pointer to the IContainer containing document version objects.

sDocTypeUID

String (maximum 256 characters)

Input

Optional input argument, string specifying the document type of document list obtained. If the doctype is not specified, all published documents are returned.

Return Value

0 if the method is successful.

A negative number if the method fails. (Check LastErrorMessage property for error message)