BSAGetData
Get a byte stream of data using buffers.
SYNOPSIS
#include <xbsa.h>
int BSAGetData(BSA_Handle bsaHandle, BSA_DataBlock32 *dataBlockPtr)
DESCRIPTION
BSAGetData() allows the caller to request a buffer full of XBSA object data from the NetBackup XBSA interface. This call is used after a BSAGetObject() call or after other BSAGetData() calls.
PARAMETERS
BSA_Handle bsaHandle (I) | This parameter is the handle that associates this call with a previous BSAInit() call. |
BSA_DataBlock32 *dataBlockPtr (I/O) | This parameter is a pointer to a structure that includes both a pointer to the buffer for the data that is to be received and the size of the buffer. Further, the API returns, in this structure, the number of bytes of data that have been sent to the caller for this call. |
EXTENDED DESCRIPTION
The NetBackup XBSA interface overwrites the numBytes field to provide the actual values used. The NetBackup XBSA interface does not modify any other fields. The XBSA application can only use the data portion of the buffer in which the XBSA object data is contained.
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_ABORT_SYSTEM_ERROR | System detected error, operation aborted. |
BSA_RC_INVALID_CALL_SEQUENCE | The sequence of API calls is incorrect. |
BSA_RC_INVALID_DATABLOCK | The BSA_DataBlock32 parameter contained an inconsistent value. |
BSA_RC_INVALID_HANDLE | The handle used to associate this call with a previous BSAInit() call is invalid. |
BSA_RC_NO_MORE_DATA | There is no more data. |
BSA_RC_NULL_ARGUMENT | A NULL pointer was encountered in one of the arguments. |
BSA_RC_SUCCESS | The function succeeded. |