Administrative API Reference

sqlencls - Close Node Directory Scan

Frees the resources that are allocated by sqlenops - Open Node Directory Scan.

Authorization

None

Required Connection

None

Version

sqlenv.h

C API Syntax 



/* File: sqlenv.h */
/* API: Close Node Directory Scan */
/* ... */
SQL_API_RC SQL_API_FN
  sqlencls (
    unsigned short Handle,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlenv.h */
/* API: Close Node Directory Scan */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgncls (
    unsigned short Handle,
    struct sqlca * pSqlca);
/* ... */

API Parameters

Handle
Input. Identifier returned from the associated OPEN NODE DIRECTORY SCAN API.

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

REXX API Syntax 



CLOSE NODE DIRECTORY :scanid

REXX API Parameters

scanid
A host variable containing the scanid returned from the OPEN NODE DIRECTORY SCAN API.

Sample Programs

C
\sqllib\samples\c\nodecat.sqc

COBOL
\sqllib\samples\cobol\nodecat.sqb

REXX
\sqllib\samples\rexx\nodecat.cmd

See Also

sqlengne - Get Next Node Directory Entry

sqlenops - Open Node Directory Scan.

[ Top of Page | Previous Page | Next Page ]