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
NBBSAGetErrorString
Get the textual error message of an XBSA error code.
SYNOPSIS
#include <nbbsa.h>
int NBBSAGetErrorString(int ErrCode, BSA_UInt32 *sizePtr, char *errorCodePtr)
DESCRIPTION
The NBBSAGetErrorString() call returns a textual description of the XBSA error code passed in.
PARAMETERS
int ErrCode (I) | The XBSA error code. |
BSA_UInt32 *sizePtr (I/O) | Pointer to the size, in characters, of the buffer pointed to by the errorCodePtr parameter. Returns the size of errorCodePtr. |
char *errorCodePtr (O) | Pointer to a buffer to receive the text of the error code. |
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_BUFFER_TOO_SMALL | The size of the data buffer is invalid. |
BSA_RC_NO_MATCH | No description for error code passed in. |
BSA_RC_NULL_ARGUMENT | A NULL pointer was encountered in one of the arguments. |
BSA_RC_SUCCESS | The function succeeded. |