Verifies that a DB2® Advanced Copy Services (ACS) operation succeeded
db2ACSApi.h
/* ==========================================================================
* Verify
* ========================================================================== */
db2ACS_RC db2ACSVerify(
db2ACS_PostObjectInfo * pPostObjInfo,
db2ACS_CB * pControlBlock,
db2ACS_ReturnCode * pRC );
db2ACS_DB2ID is a set of data that can not be known at snapshot backup object creation time, but which must be maintained in the object repository.
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 database manager populates the fields of pPostObjInfo before calling db2ACSVerify. pPostObjInfo contains information that is relevant after the DB2 ACS operation. For example, after a successful snapshot backup, pPostObjInfo might contain the first active log file. If there is no data relevant for after the DB2 ACS operation, then the database manager will set pPostObjInfo to NULL.
db2ACS_CB contains fundamental information required to initialize and terminate a DB2 ACS session.
pControlBlock->handle
pControlBlock->vendorInfo
pControlBlock->options
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 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_INV_DEV_HANDLE | The database manager passed a storage device handle that is invalid. | The DB2 ACS API driver encountered an error. The database manager cannot use the DB2 ACS API session. |
DB2ACS_RC_DEV_ERROR | There was an error with a storage device, such as a tape drive. | The DB2 ACS API driver encountered an error. The database manager cannot use the DB2 ACS API session. |
DB2ACS_RC_IO_ERROR | The DB2 ACS API driver encountered an error resulting from input or output operations. | The DB2 ACS API driver encountered an error. The database manager cannot use the DB2 ACS API session. |
For more information about DB2 ACS API return codes, see the topic: DB2 Advanced Copy Services (ACS) API return codes.
If db2ACSVerify returns that a snapshot backup operation succeeded, that means that the recovery objects generated by the snapshot backup are available to be used for restore operations.