Before retrieving, the design tool must call the GetRetrievableDocumentList method.
This method returns a list of documents for given document types (oDocTypes) that are ready for retrieval by the tool for the current plant. The design tool must allow users to select one or more documents and invoke the retrieve operation by calling Retrieve.
This method starts a Retrieve transaction. After this method is called, only the Retrieve or ReleaseRetrieveContainers method can be called to complete the transaction. If any other method is called, an appropriate error message is returned.
If the tool passed the PBS doc types in oDocTypes, the list of documents returned includes the PBS document if there are new versions in SmartPlant Foundation since the last retrieval of this document.
Arguments
Name |
Data type |
Input/output |
Description |
---|---|---|---|
oDocTypes |
ISPDocTypes |
Input |
Retrievable documents of this document type will be found. |
oDocIContainer |
IContainer |
Output |
IContainer object reference to the documents container with retrievable document objects. |
oMetaIContainer |
IContainer |
Output |
IContainer object reference to the documents container with retrievable document version objects. |
oSelectedDocIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with user selected document objects and pass in the Retrieve method. |
oSelectedMetaIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with user selected document objects and pass in the retrieve method. |
bOnlyDocsToBeRetrieved |
Boolean |
Input |
Indicates whether to return only documents that need to be retrieved or to return all documents that can be retrieved. |
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).
Comments
After calling this method, the only methods that can be called are Retrieve or ReleaseRetrieveContainers to complete the Retrieve transaction.