ReviseDocuments 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 after the GetDocumentContainersForRevise method. Calling this method completes the Revise transaction started in GetDocumentContainersForRevise method. Before calling this method, the application will fill in the oSelectedDocIContainer and oSelectedRevisionIContainer containers as described in the above section.

The ReviseDocuments method processes the documents and document revision objects as follows:

  1. For each document selected for Revise, a DocumentRevision object is added in the meta-data container with IDocumentRevision.MajorRev_ForRevise and IDocumentRevision.MinorRev_ForRevise set to user-selected values for document revision. A RevisedDocument relationship between the document object and the DocumentRevision object is added in the meta-data container.

  2. The document container with the document object and the meta-data container with the DocumentRevision and RevisedDocument relationship are passed to the tool Adapter’s ReviseDocuments method on IEFAdapter3 interface. In the Adapter’s ReviseDocuments method, the tool should get the major and minor revision numbers and persist them into its database.

Signature

ReviseDocuments (oSelectedDocIContainer as IContainer, oSelectedRevisionIContainer as IContainer) As Long

Arguments

Name

Data type

Input/output

Description

oSelectedDocIContainer

IContainer

Input

Pointer to Schema Component container object with documents that need to be revised.

oSelectedRevisionIContainer

IContainer

Output

Pointer to Schema Component container object with DocumentRevision objects for documents in oSelectedDocIContainer

Return Value

0 if the method is successful.

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