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 on Adapter interface will be called when the OK button on the Revise dialog box is clicked.

Signature

ReviseDocuments (oDocs as IContainer, oDocRevs as IContainer)

Arguments

Name

Data type

Input/output

Description

oDocs

IContainer

Output

Pointer to Schema Component container object with documents that are revised.

oDocRevs

IContainer

Output

Pointer to Schema Component container object with DocumentRevision objects (one for each document object in oDocs container)

Return Value

None.

Description

The oDocs container will have the documents objects for which the next revision number is selected in the Revise dialog. The oDevRevs container has the DocRevision objects, one for each document object in oDocs container, with DocRevision property value set to values selected in the Revise dialog. A design tool will implement this method to persist the revision numbers in its database for the current project or plant.

This method will be called only if the tool returned TRUE to ‘SPFRevisions’ in SupportsFeature method.

Comments

If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.