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

Description

This method is called by the EFCommonUI after a successful retrieval of a document by the tool in the context of a project or plant. This method has two arguments: one for the retrieved document object and the second for the retrieval time in GMT.

Tools have a choice of storing or not storing the retrieved document UID, but they must store the retrieval time in GMT. If a tool chooses not to store the document UID, then it cannot reset the design basis per document. In other words, the reset design basis methods will be called by the tool with no document ID, and the same reset time is applied to all retrieved documents. If the tool prefers to reset the design basis per retrieved document, then they must store the document UID along with last retrieved time in GMT and pass the retrieved document UIDs in the reset design basis methods.

Arguments

Name

Data type

Input/output

Description

ODocObj

IObject

Input

Retrieved document object

sRetrieveTimeInGMT

Date

Input

The time of document retrieval in GMT.

Return Value

None.

Comments

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