Search <book_title>...

Veritas NetBackup™ DataStore SDK Programmer's Guide for XBSA 1.1.0

Last Published: 2021-01-01

Product(s): NetBackup (9.0.0.1, 9.0)

BSAQueryObject

Query about the XBSA object copies.

SYNOPSIS

#include <xbsa.h>

int BSAQueryObject(BSA_Handle bsaHandle, BSA_QueryDescriptor *queryDescriptorPtr,

BSA_ObjectDescriptor *objectDescriptorPtr)

DESCRIPTION

The BSAQueryObject() call initiates a request for information on NetBackup XBSA object copies from the NetBackup XBSA interface. The results of the query are determined by the search conditions specified in the query descriptor. The XBSA object descriptor for the first XBSA object satisfying the query search conditions is returned in the BSA_ObjectDescriptor (referenced by the objectDescriptorPtr parameter). The application can obtain the other XBSA object descriptors found by the query by successive calls to BSAGetNextQueryObject().

PARAMETERS

BSA_Handle bsaHandle (I)	This parameter is the handle that associates this call with a previous BSAInit() call.
BSA_QueryDescriptor *queryDescriptorPtr (I)	This parameter is a pointer to a structure that contains the search conditions for the query.
BSA_ObjectDescriptor *objectDescriptorPtr (O)	This parameter is a pointer to a structure that is used to return the XBSA object descriptor for the first XBSA object that satisfies the search condition specified in the query.

EXTENDED DESCRIPTION

This function may only be used as part of a retrieval transaction.

A limited wildcard capability is available as follows:

Data Type	Wildcard options
string	"" matches 0 or more characters "?" matches exactly one character "\" matches a literal "*" "\?" matches a literal "?" "\\" matches a literal "\" String matching is performed without any interpretation of the string contents. There is no implied knowledge of the structure of the string contents.
time	Zero value = any time
enumerations	ANY value matches any value
BSA_ObjectOwner	Defaults to value specified at session initialization

The following examples illustrate wildcard string matching:

BSA_ObjectName.pathName = /server/*	Matches all NetBackup XBSA objects for this server
BSA_ObjectName.pathName = /server/rootdbs/*	Matches all levels of rootdbs
BSA_ObjectName.pathName = /server/????	Matches all levels whose name is exactly four characters long

RETURN VALUE

The following return codes are returned by this function:

BSA_RC_ABORT_SYSTEM_ERROR	System detected error, operation aborted.
BSA_RC_ACCESS_FAILURE	Access to the requested NetBackup XBSA object descriptor is not permitted.
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_INVALID_QUERYDESCRIPTOR	The BSA_QueryDescriptor was invalid.
BSA_RC_NO_MATCH	No NetBackup XBSA objects matched the given query.
BSA_RC_NULL_ARGUMENT	A NULL pointer was encountered in one of the arguments.
BSA_RC_SUCCESS	The function succeeded.