GetRevision 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)

The purpose of this method is to get the current revision of a document in the tool.

Typically, this method is called during publish. For tools that support the Revise command, this method replaces the GetRevision method on IEFAdapter interface. In other words, if a tool implemented IEFAdapter’s GetRevision method previously and if it is supporting the Revise command (SPFRevisions), it should implement the new GetRevision method on IEFAdapter6 interface.

Signature

GetRevision (oDocIObject as IObject, oDocRevs as IContainer)

Arguments

Name

Data type

Input/output

Description

oDocObt

IObject

Input

Document IObject.

sMajorRev

String

Output

Current major rev number.

sMinorRev

String

Output

Current minor rev number.

Return Value

None.

Description

The oDocIObject identifies the document for which the current revision is requested. The tool needs to return the current major and minor rev numbers for the document. The major and minor numbers for a document are stored by the tool in the IEFAdapter3’s ReviseDocuments method.

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

Comments

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