NBBSAGetEnv
Set the value of a single XBSA environment value.
SYNOPSIS
#include <nbbsa.h>
int NBBSAGetEnv(BSA_Handle bsaHandle, char *EnvVar, char *EnvVal, int *ValSize)
DESCRIPTION
NBBSAGetEnv() gives the XBSA application the ability to retrieve the value of a specific XBSA environment variable. The same results can be achieved by calling BSAGetEnvironment() and evaluating for the specific variable being sought.
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 environment variable. |
char *EnvVal (O) | Pointer to a buffer to receive the value of the specified environment variable. |
int *ValSize (I/O) | Pointer to the size, in characters, of the buffer pointed to by the EnvVal parameter. Returns the size of EnvVal. |
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_BUFFER_TOO_SMALL | The buffer pointed to by EnvVal is not large enough, The buffer size, in characters, required to hold the value string and its terminating null character is stored in the location pointed to by ValSize. |
BSA_RC_INVALID_ENV | The specified environment variable name was not found in the XBSA environment block for the current session. |
BSA_RC_SUCCESS | The function succeeded. |