Prior to calling this method, the tool should establish a connection to EFCommonUI by calling the 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 as shown below.
The arguments for this method are the UID and name of the document selected. It is not required that a document has to be selected before calling this method. If no document UID is passed, the Compare dialog box will be displayed with blank for document name. The Engineering Tool button allows users to select a document.
Signature
CompareWithPublishedVersion(strDocName as String, strDocUID as String) As Long
Arguments
Name |
Data type |
Input/output |
Description |
---|---|---|---|
strDocName |
String |
Input |
Name of the document to compare |
strDocUID |
String |
Input |
UID of the document. |
Return Value
0 – Successful
1 – User cancelled the operation
Negative number – Method failed. (Check the IEFCommonUIApplication.LastErrorMessage property to get the error message.)