Administrative API Reference

sqleqryc - Query Client

Returns current connection settings for an application process. For information about the applicable connection settings and their values, see SQLE-CONN-SETTING.

Authorization

None

Required Connection

None

Version

sqlenv.h

C API Syntax 



/* File: sqlenv.h */
/* API: Query Client */
/* ... */
SQL_API_RC SQL_API_FN
  sqleqryc (
    struct sqle_conn_setting * pConnectionSettings,
    unsigned short NumSettings,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlenv.h */
/* API: Query Client */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgqryc (
    struct sqle_conn_setting * pConnectionSettings,
    unsigned short NumSettings,
    struct sqlca * pSqlca);
/* ... */

API Parameters

pConnectionSettings
Input/Output. A pointer to an sqle_conn_setting structure, which specifies connection setting types and values. The user defines an array of NumSettings connection settings structures, and sets the type field of each element in this array to indicate one of the five possible connection settings options. Upon return, the value field of each element contains the current setting of the option specified. For more information about this structure, see SQLE-CONN-SETTING.

NumSettings
Input. Any integer (from 0 to 7) representing the number of connection option values to be returned.

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

REXX API Syntax 



QUERY CLIENT INTO :output

REXX API Parameters

output
A compound REXX host variable containing information about the current connection settings of the application process. In the following, XXX represents the host variable name.

XXX.1
Current connection setting for the CONNECTION type

XXX.2
Current connection setting for the SQLRULES

XXX.3
Current connection setting indicating which connections will be released when a COMMIT is issued.

XXX.4
Current connection setting of the SYNCPOINT option. Indicates whether a transaction manager should be used to enforce two-phase commit semantics, whether the database manager should ensure that there is only one database being updated when multiple databases are accessed within a single transaction, or whether neither of these options is to be used.

XXX.5
Current connection setting for the maximum number of concurrent connections for a NETBIOS adapter.

XXX.6
Current connection setting for deferred PREPARE.

Sample Programs

C
\sqllib\samples\c\client.c

COBOL
\sqllib\samples\cobol\client.cbl

REXX
\sqllib\samples\rexx\client.cmd

Usage Notes

The connection settings for an application process can be queried at any time during execution.

If QUERY CLIENT is successful, the fields in the sqle_conn_setting structure will contain the current connection settings of the application process. If SET CLIENT has never been called, the settings will contain the values of the precompile options only if an SQL statement has already been processed; otherwise, they will contain the default values for the precompile options.

For information about distributed unit of work (DUOW), see the Administration Guide.

See Also

sqleqryi - Query Client Information

sqlesetc - Set Client.

[ Top of Page | Previous Page | Next Page ]