IBM Books

API Reference

sqluhcls - 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 sqluhops - Open Recovery History File Scan.

Authorization

None

Required Connection

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

API Include File

sqlutil.h

C API Syntax 



/* File: sqlutil.h */
/* API: Close Recovery History File Scan */
/* ... */
SQL_API_RC SQL_API_FN
  sqluhcls (
    unsigned short Handle,
    void * pReserved,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlutil.h */
/* API: Close Recovery History File Scan */
/* ... */
SQL_API_RC SQL_API_FN
  sqlghcls (
    unsigned short Handle,
    void * pReserved,
    struct sqlca * pSqlca);
/* ... */

API Parameters

Handle
Input. Contains the handle for scan access that was returned by sqluhops - Open Recovery History File Scan.
pReserved
Reserved for future use.
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.

Sample Programs

C
\sqllib\samples\c\rechist.c

COBOL
\sqllib\samples\cobol\rechist.cbl

FORTRAN
\sqllib\samples\fortran\rechist.f

REXX
\sqllib\samples\rexx\rechist.cmd

Usage Notes

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

See Also

sqluhgne - Get Next Recovery History File Entry


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]