GetDocumentListContainerForDocumentDelete 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 should be called when one or more published documents are deleted in the tool database. The IContainer reference object returned by this method should be used by the tools to identify the documents for delete/terminate. This method performs the following steps:

  • Creates a container composition for GenericDocument component schema

  • Creates a container for schema objects

  • Loads GenericDocument component schema

  • Creates a container composition for document

  • Creates document containers

  • Returns Document container

Arguments

Name

Data type

Input/output

Description

oDocIContainer

IContainer

Output

IContainer reference to documents container.

Return Value

  • 0 if method is successful.

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

Comments

The only methods that can be called after GetDocumentListContainerForDocumentDelete are DeleteDocuments or ReleaseDeleteDocumentListContainer on this interface. If any other method is called, it will fail with an appropriate error message.