BSAGetNextQueryObject
Get the next NetBackup XBSA object found from a previous query.
SYNOPSIS
#include <xbsa.h>
int BSAGetNextQueryObject(BSA_Handle bsaHandle, BSA_ObjectDescriptor *objectDescriptorPtr)
DESCRIPTION
The BSAGetNextQueryObject() call returns the next NetBackup XBSA object descriptor that is a member of a previous query. Successive calls to BSAGetNextQueryObject() return all of the NetBackup XBSA object descriptors from a query one object at a time. When the last object descriptor from a query has been found, the function returns a status of BSA_RC_NO_MORE_DATA.
PARAMETERS
BSA_Handle bsaHandle (I) | This parameter is the handle that associates this call with a previous BSAInit() call. |
BSA_ObjectDescriptor *objectDescriptorPtr (O) | This parameter is a pointer to an XBSA object descriptor structure that is populated with the values from the next XBSA object in the list generated by the query. |
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_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. |