Prior to calling this method, the tool must make sure that a connection is established with the SmartPlant Foundation server, or must make a connection by calling SPCLCommonUIApplicationUI’s Connect method. The tool’s code behind the Compare with Published Version menu command will have a call to this method. The method will display the Compare dialog box.
The argument for this method is the UID of the selected document. The method accepts only one document UID. The user must select a document before calling this method. If no document UID is passed to the method, CompareWithPublishedVersion returns a negative number with a "Document UID not passed by tool" exception. If the document UID is not found on the server, CompareWithPublishedVersion displays a message box and returns 0. CompareWithPublishedVersion is not supported in File Mode.
Arguments
Name |
Data type |
Input/output |
Description |
---|---|---|---|
sDocUID |
String |
Input |
UID of the document. |
Return Value
-
0 if the method is successful.
-
1 if you cancel the operation.
-
A negative number if the method fails (check the LastErrorMessage property for error message).