Administrative API Reference

db2HistoryCloseScan - Close Recovery History File Scan

Ends a recovery history file scan and frees DB2 resources required for the scan. This API must be preceded by a successful call to db2HistoryOpenScan - Open Recovery History File Scan.

Authorization

None

Required Connection

Instance. It is not necessary to call ATTACH before calling this API.

Version

db2ApiDf.h

C API Syntax 



/* File: db2ApiDf.h */
/* API: Close Recovery History File Scan */
/* ... */
SQL_API_RC  SQL_API_FN
  db2HistoryCloseScan (
    db2Uint32 version,
    void * piHandle,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: db2ApiDf.h */
/* API: Close Recovery History File Scan */
/* ... */
SQL_API_RC  SQL_API_FN
  db2GenHistoryCloseScan (
    db2Uint32 version,
    void * piHandle,
    struct sqlca * pSqlca);
/* ... */

API Parameters

version
Input. Specifies the version and release level of the second parameter, piHandle.

piHandle
Input. Specifies a pointer to the handle for scan access that was returned by db2HistoryOpenScan - Open Recovery History File Scan.

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

REXX API Syntax 



CLOSE RECOVERY HISTORY FILE :scanid

REXX API Parameters

scanid
Host variable containing the scan identifier returned from OPEN RECOVERY HISTORY FILE SCAN.

Usage Notes

For a detailed description of the use of the recovery history file APIs, see db2HistoryOpenScan - Open Recovery History File Scan.

See Also

db2HistoryGetEntry - Get Next Recovery History File Entry

db2HistoryOpenScan - Open Recovery History File Scan

db2Prune

db2HistoryUpdate - Update Recovery History File.

[ Top of Page | Previous Page | Next Page ]