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

There will be a Retrieve command in the design tool’s menu to display retrievable documents. When a user clicks on that command, the design tool should call the ShowRetrieveDialog method.

This method will display a dialog box that shows a list of documents that are ready for retrieval by the tool for the current plant that the tool is connected to. The dialog box allows users to select one or more documents based on user’s access group and roles and invoke the retrieve operation.

The overloaded method takes the document types (ISPDocTypes) as input argument. When this argument is passed, documents belonging to the specified document types will be displayed in the Retrieve dialog box.

The list of documents in the Retrieve dialog box includes the PBS documents, if there are any new versions in SmartPlant Foundation since the last retrieval of these documents.

The Retrieve dialog box can be configured to display custom columns in the grid for custom properties that the user wants to see. This can be configured using SmartPlant Desktop Client.

When the user clicks OK, SPCLCommonUIApplicationUI communicates with SPCLClientApplication to retrieve the documents from SmartPlant Foundation, and will call the RetrieveDocument method on ISPAdapter.

Arguments(overloaded)

Name

Data type

Input/output

Description

oDocTypes

ISPDocTypes

Input

Optional. Collection of document types to display in the Retrieve dialog. Calling the signature of ShowRetrieveDialog from which this parameter is omitted is the equivalent of passing nothing in this parameter, which indicates that the method should retrieve all document types.

Return Value

  • 0 if method is successful.

  • 1 if user cancels the operation.

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

Comments

None.