This method should be called when you initiate publish operations. The IContainer object reference returned by this method should be used by design tools to identify the documents for publish. The function performs the following steps:
-
Creates a container composition for component schema
-
Creates a container for schema objects
-
Loads the component schema
-
Creates a container composition for document
-
Creates document containers (Metadata, Documents)
-
Checks if any documents have been published previously for the document UIDs (oDocUIDs) passed by the tool
-
Fills the documents container with document objects from the results of the previous step
-
Fills the new documents container with new document objects that have not been published before
-
Fills the metadata container with DocumentVersion objects for each document object in documents container. If a document can be published to multiple revisions, there will be more than one DocumentVersion object for a document for user selection.
-
Fills the metadata container with a Workflow list for user selection
-
Creates another set of document containers (Metadata, Documents) to be used by the tool to populate with user selected document objects and version objects
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocUIDs |
ISPDocUIDs |
Input |
List of document UIDs generated by the tool for the documents that have been selected by the user in the tool UI. |
|
oDocIContainer |
IContainer |
Output |
IContainer pointer to documents container with document objects previously published for given document UIDs in the oDocUIDs argument. |
|
oNewDocIContainer |
IContainer |
Output |
IContainer pointer to documents container with new document objects that have not been published previously for given document UIDs in the oDocUIDs argument. |
|
oMetaIContainer |
IContainer |
Output |
IContainer pointer to document version objects for given document UIDs in the oDocUIDs argument. |
|
oSelectedDocIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with document objects and pass in the Publish method. |
|
oSelectedMetaIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with document version objects and pass in the Publish method. |
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for an error message).
Comments
The only methods that can be called after GetDocumentListContainerForPublish are Publish or ReleasePublishDocumentListContainer on this interface. If any other method is called, it will fail with an appropriate error message.