Veritas NetBackup™ DataStore SDK Programmer's Guide for XBSA 1.1.0
- Introduction to NetBackup XBSA
- How to set up the SDK
- Using the NetBackup XBSA interface
- NetBackup XBSA data structures
- NetBackup XBSA environment
- XBSA sessions and transactions
- Creating a NetBackup XBSA application
- Initiating a session
- Backup - creating an object
- Query - finding an object descriptor
- Restore - retrieving an object's data
- Delete - deleting an object or image
- Media IDs - obtaining media IDs
- How to build an XBSA application
- How to run a NetBackup XBSA application
- About How to run a NetBackup XBSA application
- API reference
- Function calls
- Function specifications
- Type definitions
- Process flow and troubleshooting
- How to use the sample files
- Support and updates
- Appendix A. Register authorized locations
Retrieve the current NetBackup XBSA environment variables for the session.
int BSAGetEnvironment(BSA_Handle bsaHandle, BSA_UInt32 *sizePtr, char **environmentPtr)
The BSAGetEnvironment() call returns the (keyword, value) pairs that are currently defined in the NetBackup XBSA environment for the session
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.
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.
The following return codes are returned by this function:
System detected error, operation aborted.
The size of the data buffer is invalid.
The handle used to associate this call with a previous BSAInit() call is invalid.
A NULL pointer was encountered in one of the arguments.
The function succeeded.