SQLWriteDSNToIni 函数

  • 项目

一致性
引入的版本：ODBC 1.0

摘要
SQLWriteDSNToIni 将数据源添加到系统信息。

语法

  
BOOL SQLWriteDSNToIni(  
     LPCSTR   lpszDSN,  
     LPCSTR   lpszDriver);

参数

lpszDSN
[输入]要添加的数据源的名称。

lpszDriver
[输入]驱动程序说明 (通常向用户显示的关联 DBMS) 的名称，而不是物理驱动程序名称。

返回

如果成功，函数将返回 TRUE;如果失败，则返回 FALSE。

诊断

当 SQLWriteDSNToIni 返回 FALSE 时，可以通过调用 SQLInstallerError 来获取关联的 *pfErrorCode 值。 下表列出了 SQLInstallerError 可返回的 *pfErrorCode 值，并说明了此函数上下文中的每个值。

*pfErrorCode 错误 说明
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 数据源] 部分。 然后，它为数据源创建一个规范节，并将单个关键字 (驱动程序) 添加，并将驱动程序 DLL 的名称作为其值。 如果数据源规范部分已存在， SQLWriteDSNToIni 将在创建新节之前删除旧节。

此函数的调用方必须将任何特定于驱动程序的关键字和值添加到系统信息的数据源规范部分。

如果数据源的名称为 Default， SQLWriteDSNToIni 还会在系统信息中创建默认驱动程序规范部分。

仅应从安装 DLL 调用此函数。

有关以下方面的信息 请参阅
添加、修改或删除数据源 安装程序 DLL) 中的 ConfigDSN (
添加、修改或删除数据源 SQLConfigDataSource
从系统信息中删除数据源名称 SQLRemoveDSNFromIni