BSAGetEnvironment
Retrieve the current NetBackup XBSA environment variables for the session.
SYNOPSIS
#include <xbsa.h>
int BSAGetEnvironment(BSA_Handle bsaHandle, BSA_UInt32 *sizePtr, char **environmentPtr)
DESCRIPTION
The BSAGetEnvironment() call returns the (keyword, value) pairs that are currently defined in the NetBackup XBSA environment for the session
PARAMETERS
BSA_Handle bsaHandle (I) | This parameter is the handle that associates this call with a previous BSAInit() call. |
BSA_UInt32 *sizePtr (I/O) | This parameter contains the size of the environment buffer in bytes. |
char **environmentPtr (O) | This parameter is a pointer to an array of character pointers to the environment variables strings for the session. Each string consists of a keyword followed by an 9.0=9.0 followed by a null-terminated value. A NULL pointer terminates the array of pointers. |
EXTENDED DESCRIPTION
If a buffer too small error is encountered, the required size is returned in the sizePtr parameter. If the sizePtr parameter is set to zero, it forces a buffer too small error, that provides a mechanism to query the required size.
See Environment variable definitions.
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_INVALID_HANDLE | The handle used to associate this call with a previous BSAInit() call is invalid. |
BSA_RC_NULL_ARGUMENT | A NULL pointer was encountered in one of the arguments. |
BSA_RC_SUCCESS | The function succeeded. |