db2ACSEndOperation - End a Db2 Advanced Copy Services (ACS) operation

Ends a Db2 Advanced Copy Services (ACS) operation.

Include file

db2ACSApi.h

Syntax and data structures


/* ==========================================================================
 * Operation End
 * ========================================================================== */
db2ACS_RC db2ACSEndOperation(
               db2ACS_EndAction          endAction,
               db2ACS_CB               * pControlBlock,
               db2ACS_ReturnCode       * pRC );

Parameters

endAction

Data type: db2ACS_EndAction.

endAction is a bitmask indicating how the Db2 ACS API driver should end the Db2 ACS operation.

Values:

DB2ACS_END_COMMIT
DB2ACS_END_ABORT

The database manager passes endAction to the db2ACSEndOperation() function call.

pControlBlock

Data type: db2ACS_CB

db2ACS_CB contains fundamental information required to initialize and terminate a Db2 ACS session.

Before calling db2ACSEndOperation(), the database manager populates the following fields:

     pControlBlock->handle
     pControlBlock->vendorInfo
     pControlBlock->options

pRC

Data type: db2ACS_ReturnCode *

db2ACS_ReturnCode contains diagnostic information including message text and error codes specific to the storage hardware. The contents of a db2ACS_ReturnCode parameter for a Db2 ACS API function call will be recorded in the database manager diagnostic logs.

The database manager allocates the memory for this parameter, and passes a pointer to that instantiated object to the function. The database manager is responsible for freeing this memory.

The Db2 ACS API driver populates the fields of pRC before returning.

Return Codes

Table 1. Return codes
Return code	Description	Notes
`DB2ACS_RC_OK`	The operation was successful.
`DB2ACS_RC_INV_ACTION`	The database manager requested an action from the Db2 ACS API driver that is invalid.	The Db2 ACS API driver encountered an error. The database manager cannot use the Db2 ACS API session.
`DB2ACS_RC_COMMIT_FAILED`	The Db2 ACS API driver could not commit a transaction.
`DB2ACS_RC_ABORT_FAILED`	The database manager attempted to abort a Db2 ACS operation, but the attempt to abort failed.

If the Db2 ACS API driver encounters an error, the driver might abort a Db2 ACS operation. The Db2 ACS session cannot be used for any action other than the following:

If a call to db2ACSBeginQuery() previously succeeded the database manager can call db2ACSEndQuery()
If a call to db2ACSBeginOperation() previously succeeded, the database manager can call db2ACSEndOperation()
If a call to db2ACSInitialize() previously succeeded, the database manager can call db2ACSTerminate()

For more information about Db2 ACS API return codes, see the topic: Db2 Advanced Copy Services (ACS) API return codes.

Usage notes

If the database manager passes DB2ACS_END_ABORT as the endAction parameter, the result should be that the snapshot backup objects are deleted.