Description
This method will be called during publish to list the active document in the publish wizard when user does not select a document in the SmartPlant Foundation Web Client UI. The implementation of this method should do the following:
-
Get the name and type of the document that the user is currently working on.
-
Create an instance for the document object in the oDocIContainer container.
-
Get the IObject and IDocument interfaces.
-
Populate the IObject and IDocument properties.
-
Get the IissueRecordComposition and IDocVersionComposition interfaces.
Tools should be careful not to add an existing document object in a container. It
is possible that the container has documents before this method is called.
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 the SmartPlant Foundation plant that is currently connected to. |
|
sSPFProjectUID |
String (maximum 128 characters) |
Input |
Unique ID of the SmartPlant Foundation project. If not connected to a project, it NULL. |
|
sSPFProjectName |
String (maximum 256 characters) |
Input |
Name of the SmartPlant Foundation project. If not connected to a project, it NULL. |
|
oToolParameters |
IEFToolParameters |
Input |
Collection of tool parameters that were passed in Connect call of IEFCommonUI interface. Typically, tools will pass a set of tool specific parameters for their internal use. |
|
oDocIContainer |
IContainer |
Input/Output |
IContainer pointer to documents container. |
Return Value
None
Comments
If the method fails, tool will raise an error and set Err.Number and Err.Description appropriately.