DB2 Version 10.1 for Linux, UNIX, and Windows

db2DbDirCloseScan API - End a system or local database directory scan

Frees the resources allocated by db2DbDirOpenScan.

Authorization

None

Required connection

None

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2DbDirCloseScan (
       db2Uint32 versionNumber,
       void * pParmStruct,
       struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2DbDirCloseScanStruct
{
   db2Uint16 iHandle;
} db2DbDirCloseScanStruct;

SQL_API_RC SQL_API_FN
  db2gDbDirCloseScan (
       db2Uint32 versionNumber,
       void * pParmStruct,
       struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2gDbDirCloseScanStruct
{
   db2Uint16 iHandle;
} db2gDbDirCloseScanStruct;

db2DbDirCloseScan API parameters

versionNumber: Input. Specifies the version and release level of the structure passed in as the second parameter, pParmStruct.
pParmStruct: Input. A pointer to the db2DbDirCloseScanStruct structure.
pSqlca: Output. A pointer to the sqlca structure.

db2DbDirCloseScanStruct data structure parameters

iHandle: Input. Identifier returned from the associated db2DbDirOpenScan API.