The authoring tool can use the following methods to get a list of its published documents. This list helps in recreating the documents that are not in the authoring tool after a restore.
-
CreateContainersForPublishedDocList method creates containers required in the GetPublishedDocList method.
-
GetPublishedDocList method returns the document objects published by the authoring tool.
-
ReleaseContainersForPublishedDocList method releases the containers created in the CreateContainersForPublishedDocList method.
These methods must be called sequentially in the order specified.
CreateContainersForPublishedDocList As Long
This method creates the container objects required in the GetPublishedDocList method. This method must be called before calling the GetPublishedDocList method.
Arguments
None
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).
GetPublishedDocList As Long
The SmartPlant Foundation database is queried for a document list published by the tool, a document object is created in the oDocList container, and a version object is created in the oDocMeta container for each document. The version object has the revision, version and published date values.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocList |
IContainer |
Output |
Reference to the IContainer that contains document objects. |
|
ojDocMeta |
IContainer |
Output |
Reference to the IContainer that contains document version objects. |
Arguments (overloaded)
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocList |
IContainer |
Output |
Reference to the IContainer that contains document objects. |
|
oDocMeta |
IContainer |
Output |
Reference to the IContainer that contains document version objects. |
|
sDocTypeUID |
String |
Input |
Document type of document list to be obtained. If the doctype is not specified, all published documents are returned. |
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).
ReleaseContainersForPublishedDocList As Long
This method releases the containers created in the CreateContainersForPublishedDocList method. This method must be called after GetPublishedDocList method is called and the data returned in GetPublishedDocList method is processed.
Arguments
None
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).