This method must be called in conjunction with GetRetrievableDocumentList / GetRetrievableDocumentListByUID. Before calling this method, the design tool identifies the selected documents by adding them to oSelectedDocIContainer returned by the GetRetrievableDocumentList(ByUID) methods. When called, the Retrieve method interacts with SmartPlant Foundation to retrieve the selected documents and call the RetrieveDocument method on the tool adapter.
If a document fails to retrieve, the path to a log file is returned. It is the tool’s responsibility to display the log to the end user.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oSelectedDocIContainer |
IContainer |
Input |
IContainer object reference containing user selected document objects. |
|
oSelectedMetaIContainer |
IContainer |
Input |
IContainer object reference with user selected document version objects. |
|
sLogFile |
String (maximum 260 characters) |
Output |
Path to a log file with retrieve failure messages if there is a failure in retrieve. |
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.