ReleaseRetrieveContainers As Long - 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 should be called in conjunction with GetRetrievableDocumentList and GetRetrievableDocumentListByUID. The purpose of this method is to cancel the retrieve transaction started in the GetRetrievable methods called previously. The design tool should call this method if an error occurs after any of the GetRetrievable methods is called, if the design tool allows users to cancel operation after any of the GetRetrievable methods is called, or if the design tool logic forces cancelation.

ReleaseRetrieveContainers releases all pointers to Container Compositions and Containers created in the GetRetrievable methods and terminates the retrieve transaction.

Arguments

None

Return Value

0 if method is successful.

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

Comments

The design tool should release all local pointers to IContainer.