GetDocumentList - 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

This method returns a collection of documents of a given document type in the tool database for a project and a plant. If a null value is passed for document type UID, then the tool should return all the documents of all types it supports in a project of a plant. There are no arguments for project and plant in this method because these are cached as properties on IEFAdapter interface. Tools should look at these properties.

This method will be used in non-invasive compare operations.

Arguments

Name

Data type

Input/output

Description

sDocTypeUID

String (maximum 256 characters

Input

UID of Document type. If the value is NULL, documents of all publishable document types are returned.

oDocIContainer

IContainer

Input/Output

IContainer pointer to documents container.

Return Value

None

Comments

If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.