DB2 Version 10.1 for Linux, UNIX, and Windows

sqlegdgt API - Get database connection services (DCS) directory entries

Transfers a copy of Database Connection Services (DCS) directory entries to a buffer supplied by the application.

Authorization

None

Required connection

None

API include file

sqlenv.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  sqlegdgt (
        short * pNumEntries,
        struct sql_dir_entry * pDCSDirEntries,
        struct sqlca * pSqlca);

SQL_API_RC SQL_API_FN
  sqlggdgt (
        struct sqlca * pSqlca,
        short * pNumEntries,
        struct sql_dir_entry * pDCSDirEntries);

sqlegdgt API parameters

pNumEntries: Input/Output. Pointer to a short integer representing the number of entries to be copied to the caller's buffer. The number of entries actually copied is returned.
pDCSDirEntries: Output. Pointer to a buffer where the collected DCS directory entries will be held upon return of the API call. The buffer must be large enough to hold the number of entries specified in the pNumEntries parameter.
pSqlca: Output. A pointer to the sqlca structure.

Usage notes

The sqlegdsc API, which returns the entry count, must be called before issuing GET DCS DIRECTORY ENTRIES.

If all entries are copied to the caller, the Database Connection Services directory scan is automatically closed, and all resources are released.

If entries remain, subsequent calls to this API should be made, or CLOSE DCS DIRECTORY SCAN should be called, to release system resources.

REXX API syntax

GET DCS DIRECTORY ENTRY [USING :value]

REXX API parameters

value

A compound REXX host variable into which the directory entry information is returned. In the following, XXX represents the host variable name. If no name is given, the name SQLGWINF is used.

XXX.0: Number of elements in the variable (always 7)
XXX.1: RELEASE
XXX.2: LDB
XXX.3: TDB
XXX.4: AR
XXX.5: PARMS
XXX.6: COMMENT
XXX.7: RESERVED