通过


安装程序 DLL API 参考

适用于:SQL ServerAzure SQL 数据库Azure SQL 托管实例

安装程序 DLL API 提供用于以编程方式管理 ODBC 数据源、驱动程序和翻译器的功能。 应用程序和安装程序使用这些函数来安装、配置和删除 ODBC 组件,以及管理注册表信息。 Microsoft写入并重新分发安装程序 DLL。

API 由 25 个函数组成。 其中三个函数( SQLGetTranslatorSQLRemoveDSNFromIniSQLWriteDSNToIni仅通过设置 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 到 Unicode)。 当应用程序需要在与数据源通信期间进行数据转换时使用它们。

功能 Description
SQLInstallTranslatorEx 将翻译器信息添加到注册表,并递增翻译器的使用计数。
SQLInstallTranslator 安装翻译器。 废弃;请改用 SQLInstallTranslatorEx
SQLRemoveTranslator 从注册表中删除翻译器信息。 递减使用量计数,并在计数达到零时删除条目。
SQLGetTranslator 显示用于选择翻译器的对话框。 驱动程序设置 DLL 调用,提示用户选择翻译器。

注册表和配置实用工具

这些函数在 Windows 注册表的 ODBC 节中读取和写入配置数据。 其他安装程序函数和驱动程序安装 DLL 在内部使用它们。

功能 Description
SQLWriteDSNToIni 将数据源名称添加到注册表。 在创建新数据源时由驱动程序设置 DLL 调用。
SQLRemoveDSNFromIni 从注册表中删除数据源名称。 在删除数据源时由驱动程序设置 DLL 调用。
SQLGetPrivateProfileString 从注册表中的数据源规范子项读取值。
SQLWritePrivateProfileString 将值写入注册表中的数据源规范子项。
SQLGetInstalledDrivers 返回注册表中已安装的 ODBC 驱动程序的列表。
SQLGetConfigMode 检索指示哪个注册表位置(用户或系统)用于数据源条目的配置模式。
SQLSetConfigMode 设置配置模式,该模式指示在注册表中写入数据源条目的位置。

错误处理

这些函数在安装程序函数失败时提供错误信息。

功能 Description
SQLInstallerError 返回安装程序函数的错误或状态信息。 Installer DLL 中的每个函数都会发布此函数可以检索到的零个或多个错误。
SQLPostInstallerError 允许驱动程序设置 DLL 向安装程序错误队列报告错误, SQLInstallerError 以便可以返回错误。