This method is called first when the Revise command is invoked from the menu of the authoring tool. In this method, Schema Component containers are created and returned to the calling application.
This method marks the start of Revise transaction by creating document data containers and document meta-data containers. The calling application fills the data container with selected document objects.
Signature
GetDocumentContainersForRevise (oDocs as IContainer, oDocRevs as IContainer) As Long
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocUIDs |
IEFDocUIDs |
Input |
List of doc UIDs generated by the tool for the documents that have been selected by the user in the tool user interface. |
|
oDocIContainer |
IContainer |
Output |
IContainer pointer to documents container with document objects previously revised or published for given document UIDs in the oDocUIDs argument. These document objects contain only the UIDs. |
|
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. |
|
oRevisionIContainer |
IContainer |
Output |
IContainer pointer to document revision objects for given document UIDs in the oDocUIDs argument. These revision objects are empty for new documents. Otherwise, each document has corresponding revision object with the next revision values. If a document has been revised or published before, employs both major and minor revisions, and has another minor revision available for its current major revision, then there will be two revision objects in the container for the document: one revision object with the current major revision and that major revision’s next minor revision and another revision object with the next major revision and that major revision’s first minor revision. |
|
oSelectedDocIContainer |
IContainer |
Output |
Empty IContainer for the authoring tool to fill with document objects and pass in the Revise method. |
|
oSelectedMetaIContainer |
IContainer |
Output |
Empty IContainer for the authoring tool to fill with document revision objects (one per document) and pass in the Revise method. |
Return Value
0 if the method is successful.
A negative number if the method fails. (Check LastErrorMessage property for error message.)