db2HistoryCloseScan API - End the database history records scan

Ends a database history records scan and frees Db2® resources required for the scan. This API must be preceded by a successful call to the db2HistoryOpenScan API.

Note: This API is only supported in C, C++, or Java™ programming languages. It is no longer supported in COBOL, FORTRAN and REXX programming languages. You can issue a query to access database history records by using the DB_HISTORY administrative view.

Authorization

None

Required connection

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

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2HistoryCloseScan (
       db2Uint32 versionNumber,
       void * piHandle,
       struct sqlca * pSqlca);

SQL_API_RC SQL_API_FN
  db2gHistoryCloseScan (
       db2Uint32 versionNumber,
       void * piHandle,
       struct sqlca * pSqlca);

db2HistoryCloseScan API parameters

versionNumber: 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 the db2HistoryOpenScan API.
pSqlca: Output. A pointer to the sqlca structure.

Usage notes

For a detailed description of the use of the database history records APIs, refer to the db2HistoryOpenScan API.