DeleteDocuments As Long - Integration - Help

SmartPlant Integration .NET Help

PPMProductFamily
Asset Information Management
PPMProduct
Integration
PPMCategory
Help
SPFVersion_custom
2019 (10.0)
Version_Integration
(none)
Version_SPPID_custom
8.0.0
Version_SPEM_custom
2018 (9.0)

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 for details on how the document object is added to the container.)

For each document object added to the container, the SPCLCommonUI component will communicate 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

Intput

IContainer reference to documents container.

rstrLogFile

String

Output

Absolute path of the log file.

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.