BSAEndTxn
End a transaction.
SYNOPSIS
#include <xbsa.h>
int BSAEndTxn(BSA_Handle bsaHandle, BSA_Vote vote)
DESCRIPTION
BSAEndTxn() is coupled with BSABeginTxn() to identify the API call or set of API calls that are to be treated as a transaction. The caller must specify as a parameter to the BSAEndTxn() call whether or not the transaction is to be committed.
The BSA_RC_TRANSACTION_ABORTED error is only returned when a vote of BSA_Vote_COMMIT has been specified but an error has occurred that causes the transaction to be aborted. A BSAEndTxn() specifying a vote of BSA_Vote_ABORT returns a success status.
PARAMETERS
BSA_Handle bsaHandle (I) | This parameter is the handle that associates this call with a previous BSAInit() call. |
BSA_Vote vote (I) | This parameter indicates whether or not the caller wants to commit all the actions done between the previous BSABeginTxn() call and this 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 | There is no corresponding BSABeginTxn(). |
BSA_RC_INVALID_HANDLE | The handle used to associate this call with a previous BSAInit() call is invalid. |
BSA_RC_INVALID_VOTE | The value specified for vote is invalid. |
BSA_RC_SUCCESS | The function succeeded. |
BSA_RC_TRANSACTION_ABORTED | The transaction was aborted. |