Administrative API Reference
Returns information for a specific entry in the Database Connection
Services (DCS) directory.
Authorization
None
Required Connection
None
Version
sqlenv.h
C API Syntax
/* File: sqlenv.h */
/* API: Get DCS Directory Entry for Database */
/* ... */
SQL_API_RC SQL_API_FN
sqlegdge (
struct sql_dir_entry * pDCSDirEntry,
struct sqlca * pSqlca);
/* ... */
|
Generic API Syntax
/* File: sqlenv.h */
/* API: Get DCS Directory Entry for Database */
/* ... */
SQL_API_RC SQL_API_FN
sqlggdge (
struct sqlca * pSqlca,
struct sql_dir_entry * pDCSDirEntry);
/* ... */
|
API Parameters
- pSqlca
- Output. A pointer to the sqlca structure. For
more information about this structure, see SQLCA.
- pDCSDirEntry
- Input/Output. Pointer to the Database Connection Services directory
structure. For more information about this structure, see SQL-DIR-ENTRY. Fill in the ldb field of this structure
with the local name of the database whose DCS directory entry is to be
retrieved. The remaining fields in the structure are filled in upon
return of this API.
REXX API Syntax
GET DCS DIRECTORY ENTRY FOR DATABASE dbname [USING :value]
|
REXX API Parameters
- dbname
- Specifies the local database name of the directory entry to be
obtained.
- 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.
Sample Programs
- C
- \sqllib\samples\c\dcscat.c
- COBOL
- \sqllib\samples\cobol\dcscat.cbl
- FORTRAN
- \sqllib\samples\fortran\dcscat.f
- REXX
- \sqllib\samples\rexx\dcscat.cmd
See Also
sqlegdad - Catalog DCS Database
sqlegdcl - Close DCS Directory Scan
sqlegdel - Uncatalog DCS Database
sqlegdgt - Get DCS Directory Entries
sqlegdsc - Open DCS Directory Scan.
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]
[ DB2 List of Books |
Search the DB2 Books ]