DeleteDocuments 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 will be called after the Schema Component container (returned in GetDocumentListContainerForDocumentDelete method) is filled with the deleted document objects. The logic to add the document objects to the container is same as the code in Publish methods. (See Publish Functions on details on how the document object is added to the container).

For each document object added to the container EFCommonUI component will interface with the SmartPlant Server and will terminate the document in SmartPlant Foundation. Any failed documents will be reported to the end user at the end of the delete operation in text document with details on why the delete operation failed.

Arguments

Name

Data type

Input/output

Description

oDocIContainer

IContainer

Input

IContainer pointer to the documents container.

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 passed in the DeleteDocuments method after the method is called.