IBM Books

Administrative API Reference

sqlfxsys - Get Database Manager Configuration

Returns the values of individual entries in the database manager configuration file.

For a brief description of the database manager configuration parameters, see the Command Reference. For detailed information about these parameters, see the Administration Guide.

Authorization

None

Required Connection

An instance attachment is not required to perform database manager configuration operations at the current instance (as defined by the value of the DB2INSTANCE environment variable), but is required to perform database manager configuration operations at other instances. To display the database manager configuration for another instance, it is necessary to first attach to that instance.

Version

sqlutil.h

C API Syntax 



/* File: sqlutil.h */
/* API: Get Database Manager Configuration */
/* ... */
SQL_API_RC SQL_API_FN
  sqlfxsys (
    unsigned short NumItems,
    struct sqlfupd * pItemList,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlutil.h */
/* API: Get Database Manager Configuration */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgxsys (
    unsigned short NumItems,
    struct sqlfupd * pItemList,
    struct sqlca * pSqlca);
/* ... */

API Parameters

NumItems
Input. Number of entries being modified. The minimum valid value is 1.

pItemList
Input/Output. Pointer to an array of NumItems sqlfupd structures, each containing a token field indicating which value to return, and a pointer field indicating where to place the configuration value. For more information about this structure, see SQLFUPD.

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

REXX API Syntax 



GET DATABASE MANAGER CONFIGURATION USING :values

REXX API Parameters

values
A compound host variable containing tokens indicating the configuration fields to be returned. The application provides the token, and the API returns the value. XXX represents the host variable name:

XXX.0
The actual number of data elements in the remainder of the variable

XXX.1
First token

XXX.2
Value returned for the first field

XXX.3
Second token

XXX.4
Value returned for the second field

XXX.5
and so on.

Sample Programs

C
\sqllib\samples\c\dbmconf.c

COBOL
\sqllib\samples\cobol\dbmconf.cbl

FORTRAN
\sqllib\samples\fortran\dbmconf.f

REXX
\sqllib\samples\rexx\dbmconf.cmd

Usage Notes

If an attachment to a remote instance (or a different local instance) exists, the database manager configuration parameters for the attached server are returned; otherwise, the local database manager configuration parameters are returned.

The application is responsible for allocating sufficient memory for each data element returned. For example, the value returned for dftdbpath can be up to 215 bytes in length.

If an error occurs, the information returned is invalid. If the configuration file is invalid, an error message is returned. The user must install the database manager again to recover.

To set the configuration parameters to the default values shipped with the database manager, use sqlfrsys - Reset Database Manager Configuration.

For more information about these parameters, see the Administration Guide.

See Also

sqlfdsys - Get Database Manager Configuration Defaults

sqlfrsys - Reset Database Manager Configuration

sqlfusys - Update Database Manager Configuration.

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]