GetDocumentListContainerForPublish As Long - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET 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 should be called when a user clicks on the Publish command on the design tool menu to initiate publish operations. The IContainer reference object returned by this method should be used by design tool to identify the documents for publish. The following steps take place in this method:

  • Creates a container composition for GenericDocument component schema

  • Creates a container for schema objects

  • Loads GenericDocument component schema

  • Creates a container composition for document

  • Creates document containers (Metadata, Documents, and Message)

  • Returns Documents container

Arguments

Name

Data type

Input/output

Description

oDocIContainer

IContainer

Output

IContainer object with reference to documents container.

Return Value

  • 0 if method is successful.

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

Comments

The only methods that can be called after GetDocumentListContainerForPublish are ShowPublishDialog or ReleasePublishDocumentListContainer on this interface. If any other method is called, it will fail with an appropriate error message.