IBMCM_DeletePages

Deletes pages from an existing document in the IBM® Content Manager repository.

Syntax

bool IBMCM_DeletePages(int existingPage)

Parameters

Int existingPage: the existing page to delete from the document. This parameter is required.

Parameters

existingPage: required when you call this action at the Document level.

If existingPage = 0, all of the existing pages in the IBM Content Manager document are deleted. Otherwise, only the existing page that is specified by existingPage is deleted from the document.

Returns

True, if the page or pages are successfully deleted. Otherwise, False.

Level

All levels.

Details

You must retrieve the existing IBM Content Manager document from the IBM Content Manager repository before you call this action to delete pages from it.

The IBMCM_SearchItem action can be used to retrieve the existing IBM Content Manager document.

Important: Be careful with this destructive action. It should be used at the Batch level to make sure that it is run one time per batch. If you must use it at the Document or Page level, make sure that you set filters and conditions to keep this action from being called repeatedly.

Example

IBMCM_SearchItem("EmployeeID","14B04B12")
IBMCM_DeletePages(2)

This example searches the IBM Content Manager repository for the existing IBM Content Manager document with the unique attribute EmployeeID=14B0B12.

If the existing IBM Content Manager document is found, it deletes the second page from the existing IBM Content Manager document.

IBMCM_SearchItem("EmployeeID","14B04B12")
IBMCM_DeletePages(0)

This example searches the IBM Content Manager repository for the existing IBM Content Manager document with the unique attribute EmployeeID=14B0B12.

If the existing IBM Content Manager document is found, it deletes all of the pages from the existing IBM Content Manager document.