SQLWritePrivateProfileString 函数

一致性
引入的版本:ODBC 2.0

总结
SQLWritePrivateProfileString 将值名称和数据写入系统信息的Odbc.ini子项。

语法

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);  

参数

lpszSection
[输入]指向包含将字符串复制到的节的名称的以 null 结尾的字符串。 如果节不存在,则会创建一个。 节的名称与大小写无关;字符串可以是大写字母和小写字母的任意组合。

lpszEntry
[输入]指向包含要与字符串关联的键名称的以 null 结尾的字符串。 如果指定节中不存在该键,则会创建它。 如果此参数为 NULL,则会删除整个部分(包括节中的所有条目)。

lpszString
[输入]指向要写入文件的以 null 结尾的字符串。 如果此参数为 NULL,则删除 lpszEntry 参数指向的键。

lpszFilename
[输出]指向命名初始化文件的以 null 结尾的字符串。

返回

如果函数成功,则返回 TRUE;如果失败,则返回 FAL标准版。

诊断

SQLWritePrivateProfileString 返回 FAL标准版时,可以通过调用 SQLInstallerError 来获取关联的 *pfErrorCode 值。 下表列出了 SQLInstallerError 可返回*pfErrorCode 值,并解释此函数上下文中的每个值。

*pfErrorCode 错误 说明
ODBC_ERROR_GENERAL_ERR 常规安装程序错误 发生错误,没有特定的安装程序错误。
ODBC_ERROR_REQUEST_FAILED 申请失败。 无法写入请求的系统信息。
ODBC_ERROR_OUT_OF_MEM 内存不足 由于内存不足,安装程序无法执行该函数。

注释

SQLWritePrivateProfileString 是将驱动程序和驱动程序设置 DLL 从 Microsoft Windows 移植到 Microsoft Windows NT/Windows 2000 的简单方法。 对 将配置文件字符串写入Odbc.ini文件的 WritePrivateProfileString 调用应替换为对 SQLWritePrivateProfileString 的调用。 SQLWritePrivateProfileString 调用 Win32 API 中的函数,将指定的值名称和数据添加到系统信息的Odbc.ini子项。

配置模式指示列出 DSN 值的Odbc.ini条目在系统信息中的位置。 如果 DSN 是用户 DSN(状态变量为 U标准版RDSN_ONLY),则函数将写入 HKEY_CURRENT_U标准版R 中的 Odbc.ini 条目。 如果 DSN 是系统 DSN (SYSTEMDSN_ONLY),该函数将写入HKEY_LOCAL_MACHINE中的Odbc.ini条目。 如果状态变量为 BOTHDSN,则尝试HKEY_CURRENT_U标准版R,如果失败,则使用HKEY_LOCAL_MACHINE。

有关以下方面的信息 请参阅
从系统信息获取值 SQLGetPrivateProfileString