GetUserSelectionForCompare
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 SPCLCommonUI code behind the Engineering Tool button calls the GetUserSelectionForCompare method.
The implementation code for this method is similar to GetUserSelections method on ISPToolDocsForProject interface, except that only one document selection is allowed in the GetUserSelectionForCompare method.
Arguments
In project mode, the tool code uses the arguments passed, sSPFURL, sSPFPlant, sSPFProjectName, sToolProjectName and so forth, to establish the right tool project context. The code displays a dialog box in which you select one document. Then, a document object is created in the oDocContainer. For details about how to create the document object in IContainer, see GetUserSelections in ISPToolDocsForProject Interface Class.
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sSPFURL |
String |
Input |
The SmartPlant Foundation URL that is currently connected to. |
|
sSPFPlant |
String |
Input |
Name of SmartPlant Foundation plant to which the tool is currently connected. |
|
sSPFProjectName |
String |
Input |
Name of the SmartPlant Foundation project.
|
|
sToolProjectName |
String |
Input |
Name of the tool project. |
|
oDocIContainer |
IContainer |
Input/Output |
Reference to Schema Component IContainer object in which the tool adds a document object for the document selected in the tool UI. |
This argument is a placeholder for future enhancements. Tools can ignore this argument.
Return Value
None.
Comments
None.