Administrative API Reference

sqlfdsys - Get Database Manager Configuration Defaults

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

Authorization

None

Required Connection

None or instance. 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 Defaults */
/* ... */
SQL_API_RC SQL_API_FN
  sqlfdsys (
    unsigned short NumItems,
    struct sqlfupd * pItemList,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



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

API Parameters

NumItems
Input. Number of entries being returned. 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.

Sample Programs

C
\sqllib\samples\c\d_dbmcon.c

COBOL
\sqllib\samples\cobol\d_dbmcon.cbl

Usage Notes

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

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

The current value of non-updatable parameters is returned as the default.

To set the database manager configuration parameters to the recommended database manager defaults, use sqlfrsys - Reset Database Manager Configuration.

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

See Also

sqlfrsys - Reset Database Manager Configuration

sqlfusys - Update Database Manager Configuration

sqlfxsys - Get Database Manager Configuration.

[ Top of Page | Previous Page | Next Page ]