Administrative API Reference

sqlxhfrg - Forget Transaction Status

Permits the RM to erase knowledge of a heuristically completed transaction (that is, one that has been committed or rolled back heuristically).

Authorization

One of the following:

Required Connection

Database

Version

sqlxa.h

C API Syntax 



/* File: sqlxa.h */
/* API: Forget Transaction Status */
/* ... */
extern int SQL_API_FN sqlxhfrg(
   SQLXA_XID            *pTransId,
   struct sqlca         *pSqlca
   );
/* ... */

API Parameters

pTransId
Input. XA identifier of the transaction to be heuristically forgotten, or removed from the database log.

pSqlca
Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

Usage Notes

Only transactions with a status of heuristically committed or rolled back can have the FORGET operation applied to them.

For information about the SQLXA_XID structure, see SQLXA-XID.

[ Top of Page | Previous Page | Next Page ]