OpenAPI User Guide > OpenAPI User Guide > OpenAPI Function Reference > OpenAPI Functions > IIapi_xaRollback() Function--Rollback an XA Transaction
Was this helpful?
IIapi_xaRollback() Function--Rollback an XA Transaction
The IIapi_xaRollback() function aborts an XA transaction started with IIapi_xaStart(). The connection handle does not need to be the same as was originally associated with the XA transaction when started by IIapi_xaStart().
If the XA transaction is associated with a connection (IIapi_xaEnd() has not been used to drop the association), IIapi_rollback() will need to be used to free the resources of the active transaction handle. Otherwise, the transaction state of the connection used to commit the XA transaction is not affected.
This function has the following syntax:
II_VOID IIapi_xaRollback( IIAPI_XAROLLPARM *rollbackParm );
 
typedef struct _IIAPI_XAROLLPARM
{
        IIAPI_GENPARM           xr_genParm;
        II_PTR                  xr_connHandle;
        IIAPI_TRAN_ID           xr_tranID;
        II_ULONG                xr_flags;
} IIAPI_XAROLLPARM;
This function has the following parameters:
xr_genParm
Type: input and delayed output
Specifies the generic parameters (see Generic Parameters).
xr_connHandle
Type: input
Specifies the connection handle identifying the connection to be used to prepare the XA transaction.
xr_tranID
Type: input
Specifies the XA transaction ID of the transaction which is to be rolled back.
xr_flags
Type: input
Specifies optional transaction flags. Currently, no additional flags are defined. This parameter should be set to 0.
Last modified date: 08/14/2024