DB2 Version 10.1 for Linux, UNIX, and Windows

sqlenops API - Start a node directory scan

Stores a copy in memory of the node directory, and returns the number of entries. This is a snapshot of the directory at the time the directory is opened. This copy is not updated, even if the directory itself is changed later.

Call the sqlengne API to advance through the node directory and examine information about the node entries. Close the scan by calling the sqlencls API. This removes the copy of the directory from memory.

Authorization

None

Required connection

None

API include file

sqlenv.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  sqlenops (
        unsigned short * pHandle,
        unsigned short * pNumEntries,
        struct sqlca * pSqlca);

SQL_API_RC SQL_API_FN
  sqlgnops (
        unsigned short * pHandle,
        unsigned short * pNumEntries,
        struct sqlca * pSqlca);

sqlenops API parameters

pHandle: Output. Identifier returned from this API. This identifier must be passed to the sqlengne API and sqlencls API.
pNumEntries: Output. Address of a 2-byte area to which the number of directory entries is returned.
pSqlca: Output. A pointer to the sqlca structure.

Usage notes

Storage allocated by this API is freed by calling sqlencls - Close Node Directory Scan.

Multiple node directory scans can be issued against the node directory. However, the results may not be the same. The directory may change between openings.

There can be a maximum of eight node directory scans per process.

REXX API syntax

OPEN NODE DIRECTORY USING :value

REXX API parameters

value

A compound REXX variable to which node directory information is returned. In the following, XXX represents the host variable name.

XXX.0: Number of elements in the variable (always 2)
XXX.1: Specifies a REXX host variable containing a number for scanid
XXX.2: The number of entries contained within the directory.