Функция SQLSetConfigMode

Соответствия
Представлена версия: ODBC 3.0

Сводка
SQLSetConfigMode задает режим конфигурации, указывающий, где запись Odbc.ini содержит значения DSN в системной информации.

Синтаксис

  
BOOL SQLSetConfigMode(  
     UWORD     wConfigMode);  

Аргументы

wConfigMode
[Входные данные] Режим конфигурации установщика (см. раздел "Комментарии"). Значение в wConfigMode может быть следующим:

ODBC_USER_DSN

ODBC_SYSTEM_DSN

ODBC_BOTH_DSN

Возвраты

Функция возвращает значение TRUE, если оно выполнено успешно, значение FALSE, если оно завершается ошибкой.

Диагностика

Когда SQLSetConfigMode возвращает ЗНАЧЕНИЕ FALSE, связанное значение *pfErrorCode можно получить путем вызова SQLInstallerError. В следующей таблице перечислены значения *pfErrorCode , которые можно возвращать SQLInstallerError и объясняет каждый из них в контексте этой функции.

*pfErrorCode	Error	Description
ODBC_ERROR_INVALID_PARAM_SEQUENCE	Недопустимая последовательность параметров	Аргумент wConfigMode не содержал ODBC_USER_DSN, ODBC_SYSTEM_DSN или ODBC_BOTH_DSN.

Комментарии

Эта функция используется для задания того, где в системной информации содержатся значения DSN в записи Odbc.ini. Если wConfigMode ODBC_USER_DSN, dsN — это имя пользователя, а функция считывается из записи Odbc.ini в HKEY_CURRENT_USER. Если это ODBC_SYSTEM_DSN, dsN — это системное доменное имя, а функция считывается из записи Odbc.ini в HKEY_LOCAL_MACHINE. Если это ODBC_BOTH_DSN, HKEY_CURRENT_USER пробуется, и если он завершается ошибкой, используется HKEY_LOCAL_MACHINE.

Эта функция не влияет на SQLCreateDataSource и SQLDriverConnect. Режим конфигурации необходимо задать при чтении драйвера из реестра путем вызова SQLGetPrivateProfileString или записи в реестр путем вызова SQLWritePrivateProfileString. Вызовы SQLGetPrivateProfileString и SQLWritePrivateProfileString используют режим конфигурации, чтобы узнать, с какой частью реестра следует работать.

Внимание

SQLSetConfigMode следует вызывать только при необходимости. Если режим неправильно задан, установщик ODBC может не работать должным образом.

SQLSetConfigMode вносит прямое изменение реестра в режим конфигурации. Это отличается от процесса изменения режима конфигурации вызовом SQLConfigDataSource. Вызов SQLConfigDataSource задает режим конфигурации для различения доменных имен пользователей и системных доменных имен при изменении имени DSN. Перед возвратом SQLConfigDataSource сбрасывает режим конфигурации в BOTHDSN.

Связанные функции

Сведения	Раздел
Создание источника данных	SQLCreateDataSource
Подключение к источнику данных с помощью строки подключения или диалогового окна	SQLDriverConnect
Получение режима конфигурации	SQLGetConfigMode