This method should be called in conjunction with GetRetrievableDocumentList and GetRetrievableDocumentListByUID. Before calling this method, the design tool would identify the selected documents by adding them to oSelectedDocIContainer returned by the GetRetrievable methods. When called, the Retrieve method would interact 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 will be 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 with selected document objects. |
oSelectedMetaIContainer |
IContainer |
Input |
IContainer with 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.
1 if the user cancels the operation in the Publish dialog.
A negative number if method fails. (Check the LastErrorMessage property for error message.)
Comments
The design tool should release all local pointers to IContainer passed in the Publish method after the method is called.