GetDocRevisionHistory 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 revision history of a document in the tool.

It is possible that a document can be revised several times between publishes. It is expected that the design tool will keep a history of the document revisions. The SmartPlant Client will call this method during publishing, if the SmartPlant Client recognizes that a document has been revised more than once between publishes.

Signature

GetDocRevisionHistory (oDocIObject as IObject, oDocRevs as IContainer)

Arguments

Name

Data type

Input/output

Description

oDocIObject

IObject

Input

Document IObject.

ODocRevs

IContainer

Output

Pointer to Schema Component container object with DocumentRevision objects.

Return Value

None.

Description

The oDocIObject identifies the document for which the revision history is requested. The oDocRevs container is passed empty to the tool. The tool needs to fill the container with DocRevision objects with MajorRev_ForRevise and MinorRev_ForRevise properties on IDocumentRevision interface set. There should be one DocRevision object for each revision in the current project or plant. A RevisedDocument relationship between the document object and the DocumentRevsion object should be added for each DocumentRevision object.

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.