Функция SQLWriteDSNToIni

  • Статья

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

Сводка
SQLWriteDSNToIni добавляет источник данных в системную информацию.

Синтаксис

  
BOOL SQLWriteDSNToIni(  
     LPCSTR   lpszDSN,  
     LPCSTR   lpszDriver);

Аргументы

lpszDSN
[Входные данные] Имя добавляемого источника данных.

lpszDriver
[Входные данные] Описание драйвера (обычно имя связанной СУБД), представленное пользователям вместо имени физического драйвера.

Возвраты

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

Диагностика

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

*pfErrorCode Error Description
ODBC_ERROR_GENERAL_ERR Общая ошибка установщика Произошла ошибка, для которой не было определенной ошибки установщика.
ODBC_ERROR_INVALID_DSN Недопустимая dsN Аргумент lpszDSN содержал строку, которая была недопустимой для dsN.
ODBC_ERROR_INVALID_NAME Недопустимое имя драйвера или переводчика Недопустимый аргумент lpszDriver .
ODBC_ERROR_REQUEST_FAILED Не удалось выполнить запрос Установщик не удалось создать имя DSN в реестре.
ODBC_ERROR_OUT_OF_MEM Недостаточно памяти Установщик не мог выполнить функцию из-за нехватки памяти.

Комментарии

SQLWriteDSNToIni добавляет источник данных в раздел [Источники данных ODBC] системной информации. Затем он создает раздел спецификации для источника данных и добавляет одно ключевое слово (Driver) с именем библиотеки DLL драйвера в качестве значения. Если раздел спецификации источника данных уже существует, SQLWriteDSNToIni удаляет старый раздел перед созданием нового.

Вызывающий объект этой функции должен добавить все ключевые слова и значения для конкретного драйвера в раздел спецификации источника данных системной информации.

Если имя источника данных — Default, SQLWriteDSNToIni также создает раздел спецификации драйвера по умолчанию в системной информации.

Эта функция должна вызываться только из библиотеки DLL установки.

Сведения Раздел
Добавление, изменение или удаление источника данных ConfigDSN (в библиотеке DLL установки)
Добавление, изменение или удаление источника данных SQLConfigDataSource
Удаление имени источника данных из системной информации SQLRemoveDSNFromIni