GetDocumentContainersForRevise Method - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

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 the Revise transaction by creating a document data container (oDocs) and a document meta-data container (oDocRevs). The calling application fills the data container with selected document objects.

If a selected document was previously revised, the calling application (tool) should create a corresponding DocumentRevision object in the oDocRevs (meta-data) container and a RevisedDocument relationship between the document object and the DocumentRevision object. The DocumentRevision has an interface called IdocumentRevision, which carries MajorRev_ForRevise and MinorRev_ForRevise properties. The tool must set these properties to the current major revision number and minor revision number. The tool should get the current major and minor revision numbers from its database, where they were saved by the tool’s adapter ReviseDocuments method of IEFAdapter3 interface.

Signature

GetDocumentContainersForRevise (oDocs as IContainer, oDocRevs as IContainer) As Long

Arguments

Name

Data type

Input/output

Description

oDocs

IContainer

Output

Pointer to Schema Component container object. This container is empty and used by the application to create document objects.

oDocRevs

IContainer

Output

Pointer to Schema Component container. This container is empty and used by the application to create DocumentRevision objects.

Return Value

0 if method is successful.

A negative number if method fails. (Check LastErrorMessage property for error message.)