BSAQueryServiceProvider
Retrieve a string identifying NetBackup provider.
SYNOPSIS
#include <xbsa.h>
int BSAQueryServiceProvider(BSA_UInt32 *sizePtr, char *delimiter, char *providerPtr)
DESCRIPTION
The BSAQueryServiceProvider() call returns a hierarchical string identifying NetBackup provider.
PARAMETERS
BSA_UInt32 *sizePtr (I/O) | This parameter contains the size of the provider buffer in bytes. |
char *delimiter (O) | This parameter is a pointer to the character that is used to delimit fields in the provider hierarchical string. |
char *providerPtr (O) | This parameter is a pointer to a data area that contains hierarchical string which conveys information identifying NetBackup provider. |
EXTENDED DESCRIPTION
The format of the provider string is the same as the NetBackup XBSA environment variable BSA_SERVICE_PROVIDER (see BSAGetEnvironment). The delimiter character is returned in the delimiter parameter.
If a BSA_RC_BUFFER_TOO_SMALL error is encountered, the required size is returned in the sizePtr parameter. If the XBSA application sets the sizePtr parameter to zero, it forces a BSA_RC_BUFFER_TOO_SMALL error that provides a mechanism to query the required size.
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_ABORT_SYSTEM_ERROR | System detected error, operation aborted. |
BSA_RC_BUFFER_TOO_SMALL | The size of the data buffer is invalid. |
BSA_RC_NULL_ARGUMENT | A NULL pointer was encountered in one of the arguments. |
BSA_RC_SUCCESS | The function succeeded. |