NBBSAGetJobId
Obtain the job ID for a backup or restore transaction.
SYNOPSIS
#include <nbbsa.h>
int NBBSAGetJobId(BSA_Handle bsaHandle, int *jobId)
DESCRIPTION
NBBSAGetJobId() returns the job ID associated with a backup or restore transaction. To retrieve the job ID for a backup transaction, NBBSAGetJobId() can be called any time after the BSACreateObject() call, but before the BSAEndTxn() call. To retrieve the job ID for a restore transaction, NBBSAGetJobId() can be called any time after the BSAGetObject() call, but before the BSAEndTxn() call. To retrieve the job ID for a multiple object restore transaction, NBBSAGetJobId() can be called any time after the NBBSAGetMultipleObjects() call, but before the BSAEndTxn() call.
PARAMETERS
BSA_Handle bsaHandle (I) | The handle that associates this call with a previous BSAInit() call. |
int *jobId (O) | Pointer to the job ID for the current backup or restore. |
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_NULL_ARGUMENT | A NULL pointer was encountered in one of the arguments. |
BSA_RC_ABORT_SYSTEM_ERROR | System detected error, operation aborted. |
BSA_RC_INVALID_CALL_SEQUENCE | The sequence of API calls is incorrect. This code is returned if the current transaction is not a backup or restore transaction. During a backup transaction, this code is returned if NBBSAGetJobId() is called before BSACreateObject() or after BSAEndTxn(). During a restore transaction, this code is returned if NBBSAGetJobId() is called before BSAGetObject () or after BSAEndTxn(). During a multiple object restore transaction, this code is returned if NBBSAGetJobId() is called before NBBSAGetMultipleObjects() or after BSAEndTxn(). |
BSA_RC_INVALID_HANDLE | The handle used to associate this call with a previous BSAInit() call is invalid. |
BSA_RC_SUCCESS | The function succeeded. |