Поделиться через


Справочник по API DLL установщика

Область применения:SQL ServerБаза данных SQL AzureУправляемый экземпляр SQL Azure

API DLL установщика предоставляет функции программного управления источниками данных ODBC, драйверами и переводчиками. Приложения и программы установки используют эти функции для установки, настройки и удаления компонентов ODBC и управления сведениями о реестре. Корпорация Майкрософт записывает и распространяет библиотеку DLL установщика.

API состоит из 25 функций. Три из этих функций, SQLGetTranslatorSQLRemoveDSNFromIniа SQLWriteDSNToIniтакже вызываются только библиотеками DLL установки. Программы установки и администрирования вызывают другие функции.

Каждая функция помечена версией ODBC, в которой она появилась.

Конфигурация источника данных

Эти функции создают, изменяют и удаляют источники данных ODBC программным способом. Используйте их при создании пользовательских программ установки или приложений, которые должны настраивать подключения к источнику данных без взаимодействия с пользователем.

Функция Description
SQLConfigDataSource Добавляет, изменяет или удаляет источник данных. Вызывает библиотеку DLL установки драйвера для выполнения фактической конфигурации.
SQLCreateDataSource Отображает диалоговое окно, позволяющее пользователям добавлять источник данных в интерактивном режиме.
SQLManageDataSources Отображает диалоговое окно для управления источниками данных и параметрами трассировки, аналогично администратору источника данных ODBC.
SQLValidDSN Проверяет длину и допустимость имени источника данных перед записью в реестр.
SQLReadFileDSN Считывает сведения о подключении из имени источника данных на основе файлов (DSN-файл).
SQLWriteFileDSN Записывает сведения о подключении в имя источника данных на основе файлов (DSN-файл).
SQLRemoveDefaultDataSource Удаляет источник данных по умолчанию из системных сведений.

Установка и удаление драйверов

Эти функции устанавливают и удаляют драйверы ODBC из системы. Они управляют записями реестра и счетчиками использования для поддержки нескольких приложений, использующих одни и те же драйверы.

Функция Description
SQLInstallDriverEx Добавляет сведения о драйвере в реестр и увеличивает количество использования драйвера. Возвращает целевой каталог для файлов драйверов.
SQLInstallDriverManager Возвращает целевой каталог для установки основных компонентов ODBC. Не рекомендуется использовать в ODBC 3.0, так как диспетчер драйверов является частью Windows.
SQLRemoveDriver Удаляет сведения о драйвере из реестра. Уменьшает количество использования драйвера и удаляет записи реестра, когда число достигает нуля.
SQLRemoveDriverManager Уменьшает количество использования основных компонентов ODBC. Не рекомендуется, так как диспетчер драйверов теперь является частью Windows.
SQLConfigDriver Загружает библиотеку DLL установки драйвера и вызывает ее ConfigDriver функцию для выполнения задач конфигурации для конкретного драйвера.

Установка и удаление переводчика

Эти функции управляют переводчиками ODBC, которые преобразуют данные между символьными наборами (например, ANSI в Юникод). Используйте их, когда приложению требуется перевод данных во время взаимодействия с источником данных.

Функция Description
SQLInstallTranslatorEx Добавляет сведения переводчика в реестр и увеличивает количество использования переводчика.
SQLInstallTranslator Устанавливает переводчик. Устаревшие; вместо этого используйте SQLInstallTranslatorEx .
SQLRemoveTranslator Удаляет сведения переводчика из реестра. Уменьшает количество использования и удаляет записи, когда число достигает нуля.
SQLGetTranslator Отображает диалоговое окно для выбора переводчика. Вызывается библиотеками DLL установки драйвера для запроса пользователей на выбор переводчика.

Служебные программы реестра и конфигурации

Эти функции считывают и записывают данные конфигурации в разделе ODBC реестра Windows. Другие функции установщика и библиотеки DLL установки драйверов используют их внутренне.

Функция Description
SQLWriteDSNToIni Добавляет имя источника данных в реестр. Вызывается библиотеками DLL установки драйвера при создании нового источника данных.
SQLRemoveDSNFromIni Удаляет имя источника данных из реестра. Вызывается библиотеками DLL установки драйвера при удалении источника данных.
SQLGetPrivateProfileString Считывает значение из подраздела спецификации источника данных в реестре.
SQLWritePrivateProfileString Записывает значение в подраздел спецификации источника данных в реестре.
SQLGetInstalledDrivers Возвращает список установленных драйверов ODBC из реестра.
SQLGetConfigMode Извлекает режим конфигурации, указывающий, какое расположение реестра (пользователь или система) используется для записей источника данных.
SQLSetConfigMode Задает режим конфигурации, указывающий, где записываются записи источника данных в реестре.

Обработка ошибок

Эти функции предоставляют сведения об ошибках при сбое функций установщика.

Функция Description
SQLInstallerError Возвращает сведения об ошибке или состоянии для функций установщика. Каждая функция в библиотеке DLL установщика публикует нулю или больше ошибок, которые могут быть получены этой функцией.
SQLPostInstallerError Позволяет библиотекам DLL установки драйверов сообщать об ошибках в очередь ошибок установщика, чтобы SQLInstallerError они могли возвращать их.