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
- Getting help with the API
- NetBackup XBSA data structures
- NetBackup XBSA environment
- XBSA sessions and transactions
- Creating a NetBackup XBSA application
- How to build an XBSA application
- How to run a NetBackup XBSA application
- API reference
- Error messages
- Function calls
- Function specifications
- BSABeginTxn
- BSACreateObject
- BSADeleteObject
- BSAEndData
- BSAEndTxn
- BSAGetData
- BSAGetEnvironment
- BSAGetLastError
- BSAGetNextQueryObject
- BSAGetObject
- BSAInit
- BSAQueryApiVersion
- BSAQueryObject
- BSAQueryServiceProvider
- BSASendData
- BSATerminate
- NBBSAAddToMultiObjectRestoreList
- NBBSADeleteImage
- NBBSAEndGetMultipleObjects
- NBBSAFreeJobInfo
- NBBSAGetEnv
- NBBSAGetErrorString
- NBBSAGetJobId
- NBBSAGetJobInfo
- NBBSAGetMediaIds
- NBBSAGetMultipleObjects
- NBBSAGetServerError
- NBBSALogMsg
- NBBSASetEnv
- NBBSAUpdateEnv
- NBBSAValidateFeatureId
- Type definitions
- Process flow and troubleshooting
- How to use the sample files
- Support and updates
- Appendix A. Register authorized locations
- Index
NBBSASetEnv
Set the value of a single XBSA environment value.
SYNOPSIS
#include <nbbsa.h>
int NBBSASetEnv(BSA_Handle bsaHandle, char *EnvVar, char *EnvVal)
DESCRIPTION
NBBSASetEnv() gives the XBSA application the ability to set the value of a specific XBSA environment variable after the beginning of a session. If the variable does not exist in the environment, it is added. If the variable exists in the environment, the value is replaced. Some of the XBSA environment variables can only be set or updated at certain points in the session. See Environment variable definitions. If the variable cannot be set or updated, the original value remains.
The XBSA specifications do not provide a way for these XBSA environment variables to be reset after the session has been initiated with BSAInit().
PARAMETERS
BSA_Handle bsaHandle (I) | The handle that associates this call with a previous BSAInit() call. |
char *EnvVar (I) | Pointer to a null-terminated string that specifies the XBSA environment variable whose value is being set. |
char *EnvVal (I) | Pointer to a null-terminated string containing the new value of the specified XBSA environment variable. If this parameter is NULL, the variable is deleted from the current sessions XBSA environment. |
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_SUCCESS | The specified XBSA environment variable has been set. |
BSA_RC_NULL_ARGUMENT | A required argument was passed as a NULL pointer. |
BSA_RC_ABORT_SYSTEM_ERROR | Unable to increase the size of the session's XBSA environment block. |
BSA_RC_INVALID_ENV | The variable is not a supported environment variable. |