SQLGetConfigMode

Conformance

Version Introduced: ODBC 3.0

Summary

SQLGetConfigMode retrieves the configuration mode that indicates where the ODBC.INI entry listing DSN values is in the system information.

Syntax

BOOL SQLGetConfigMode(
   UWORD *   pwConfigMode);

Arguments

pwConfigMode

[Output]
Pointer to the buffer containing the configuration mode (see “Comments”). The value in *pwConfigMode can be:

ODBC_USER_DSN
ODBC_SYSTEM_DSN
ODBC_BOTH_DSN

Returns

The function returns TRUE if it is successful, FALSE if it fails.

Diagnostics

When SQLGetConfigMode returns FALSE, an associated *pfErrorCode value may be obtained by calling SQLInstallerError. The following table lists the *pfErrorCode values that can be returned by SQLInstallerError and explains each one in the context of this function.

Comments

This function is used to determine where the ODBC.INI entry listing DSN values is in the system information. If *pwConfigMode is ODBC_USER_DSN, the DSN is a User DSN and the function reads from the ODBC.INI entry in HKEY_CURRENT_USER. If it is ODBC_SYSTEM_DSN, the DSN is a System DSN and the function reads from the ODBC.INI entry in HKEY_LOCAL_MACHINE. If it is ODBC_BOTH_DSN, HKEY_CURRENT_USER is tried, and if it fails, then HKEY_LOCAL_MACHINE is used.

By default, SQLGetConfigMode returns ODBC_BOTH_DSN. When a User DSN or a System DSN is created by a call to SQLConfigDataSource, the function sets the configuration mode to ODBC_USER_DSN or ODBC_SYSTEM_DSN to distinguish user and System DSNs while modifying a DSN. Prior to returning, SQLConfigDataSource resets the configuration mode to ODBC_BOTH_DSN.

Related Functions