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
BSAEndData
End a BSAGetData() or BSASendData() sequence.
SYNOPSIS
#include <xbsa.h>
int BSAEndData(BSA_Handle bsaHandle)
DESCRIPTION
The caller issues BSAEndData() after a call to BSACreateObject() followed by zero or more BSASendData() calls, or after a call to BSAGetObject() followed by zero or more BSAGetData() calls to signify the end of data. When used with BSAGetObject() or BSAGetData() calls, BSAEndData() does not transfer any more data for the NetBackup XBSA object to the caller. When used with BSACreateObject() or BSASendData() calls, BSAEndData() tells the NetBackup XBSA interface that the caller has finished sending data for a particular NetBackup XBSA object. BSAEndData() signifies the end of data for the immediately preceding BSACreateObject(), BSAGetObject(), BSAGetData(), or BSASendData().
It is also required after a call to BSAGetObject() or BSACreateObject() if the object is empty.
PARAMETERS
BSA_Handle bsaHandle (I) | This parameter is the handle that associates this call with a previous BSAInit() call. |
RETURN VALUE
The following return codes are returned by this function:
BSA_RC_ABORT_SYSTEM_ERROR | System detected error, operation aborted. |
BSA_RC_INVALID_CALL_SEQUENCE | The sequence of API calls is incorrect. |
BSA_RC_INVALID_HANDLE | The handle used to associate this call with a previous BSAInit() call is invalid. |
BSA_RC_SUCCESS | The function succeeded. |