PACKAGE_DESTROY

Deletes a package

Syntax

CALL PACKAGE_DESTROY(packageId, rc);

Required Arguments

packageId
identifies the package to be deleted.
Type:Numeric, Input
rc
receives a return code.
Type:Numeric, Output

Details

If the queue transport is used, then the package is removed from the queue, along with all messages that are associated with the package. If the package contains nested packages, then all entries that are contained within the nested packages are also removed from the queue. If the archive transport is used, then the archive is deleted. If the WebDAV transport is used, then the package and its contents are deleted from the WebDAV server. If the SharePoint transport is used, then the package and its contents are removed from the SharePoint server.
The PACKAGE_DESTROY CALL routine does not support package identifiers that represent nested packages, which are returned by way of the RETRIEVE_NESTED CALL routine. The PACKAGE_DESTROY CALL routine supports only top-level package identifiers, which are returned by PACKAGE_FIRST and PACKAGE_NEXT.

Example: Using PACKAGE_DESTROY

The following example removes a package from a queue.
rc=0;
CALL PACKAGE_DESTROY(packageId, rc);