Description
This method is called when the Engineering Tool button is clicked on the Compare with Published Version dialog box.
The tool code uses the arguments passed (such as sSPFURL, sSPFPlant, and so forth) to establish the right tool in a project context. The code displays the Select Documents dialog box where the user can select one document to compare with. After a document is created, a Document object is created in the oDocContainer. For details on how to create the Document object in IContainer, see GetUserSelections.
Tools that support the Compare with Published Version command implement this method to select a document in the tool database to compare with a published version. The EFCommonUI’s code behind the Engineering Tool button calls the GetUserSelectionForCompare method. The implementation code for this method is similar to the GetUserSelections method on the IEFToolDocsForProject interface except only one document selection can be allowed on the GetUserSelectionForCompare method.
The IEFToolDocsForProject2 interface must be implemented in the same DLL in which
the IEFToolDocsForProject interface is implemented.
Arguments
|
Name |
Data type |
Input/ output |
Description |
|---|---|---|---|
|
sSPFURL |
String (maximum 128 characters) |
Input |
The SmartPlant Foundation URL that is currently connected to. |
|
sSPFPlant |
String (maximum 254 characters) |
Input |
Name of SmartPlant Foundation plant that is currently connected to. |
|
sSPFProjectName |
String (maximum 256 characters) |
Input |
Name of the SmartPlant Foundation project. If not connected to a project, it is NULL. |
|
sToolProjectName |
String (maximum 256 characters) |
Input |
Name of the tool project. If not connected to a project, it is NULL. |
|
oToolParameters |
IEFToolParameters |
Input |
Collection of tool parameters that were passed in the Connect call of the IEFCommonUI interface. Typically, tools pass a set of tool specific parameters for their internal use. |
|
oDocIContainer |
IContainer |
Input/output |
IContainer pointer to documents container. |
Return Value
None.
Impacts
None.