OpenAPI User Guide > OpenAPI User Guide > OpenAPI Function Reference > OpenAPI Functions > IIapi_xaStart() Function--Start an XA Transaction
Was this helpful?
IIapi_xaStart() Function--Start an XA Transaction
The IIapi_xaStart() function starts an XA transaction on a connection. An XA transaction handle is returned, which can be used to execute queries using IIapi_query() or IIapi_batch() within the context of the XA transaction.
The XA transaction handle allocated by this function should be released using IIapi_xaEnd(). The transaction handle can also be released using IIapi_commit() or IIapi_rollback() if conditions do not require full distributed XA processing.
This function has the following syntax:
II_VOID IIapi_xaStart( IIAPI_XASTARTPARM *startParm );
 
typedef struct _IIAPI_XASTARTPARM
{
        IIAPI_GENPARM           xs_genParm;
        II_PTR                  xs_connHandle;
        IIAPI_TRAN_ID           xs_tranID;
        II_ULONG                xs_flags;
        II_PTR                  xs_tranHandle;
} IIAPI_XASTARTPARM;
This function has the following parameters:
xs_genParm
Type: input and delayed output
Specifies the generic parameters (see Generic Parameters).
xs_connHandle
Type: input
Specifies the connection handle identifying the connection associated with the XA transaction.
xs_tranID
Type: input
Specifies the XA transaction ID to be associated with the XA transaction.
xs_flags
Type: input
Specifies optional transaction flags. This parameter is 0 or a mask of the following values:
IIAPI_XA_JOIN
Joins an existing XA transaction.
xs_tranHandle
Type: immediate output
Specifies the transaction handle to be used during the XA transaction.
 
Last modified date: 01/30/2023