There will a Find Documents to Publish command on the design tool menu to find if there are any documents to publish since the last publish in the current plant/project context. The design tool should call this method to perform that function.
The method will display the Find Documents To Publish dialog boxes as described in the EF CommonUI GUI design document.
In phase 3, some tools (SmartPlant® P&ID, for instance) are keeping track of documents published and documents modified since the last publish. In this case, EFCommonUI will communicate with EFAdapter to get a list of documents to publish from the tool.
If the tool does not support this feature, then EFCommonUI will perform a time-consuming comparison of document XMLs in SmartPlant Foundation with XMLs generated by the tool to come up with a list documents to publish. This comparison will be done asynchronously.
The project/plant context for this operation is the same as the context set in the
Connect method. Before calling this method, the design tool must make sure that the
context for this operation is the same as the context set in the Connect method. If
the operation context is different, the Connect method should be called again with
the right context.
Arguments
None
Return Value
0 if method is successful.
1 if the user cancels the operation in publish wizard.
A negative number if method fails. (Check the LastErrorMessage property for error message.)
Comments
None