SQLWriteFileDSN 函数

一致性
引入的版本：ODBC 3.0

摘要
SQLWriteFileDSN 将信息写入文件 DSN。

语法

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);  

参数

lpszFileName
[输入]指向文件 DSN 名称的指针。 DSN 扩展名追加到所有没有 DSN 扩展名的文件名。

lpszAppName
[输入]指向应用程序名称的指针。 这是 ODBC 节的“ODBC”。

lpszKeyName
[输入]指向要读取的密钥名称的指针。 有关保留关键字，请参阅“注释”。

lpszString
[输出]指向与要写入的键关联的字符串。 此参数指向的字符串的最大长度为 32，767 个字节。

返回

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

诊断

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

*pfErrorCode	错误	说明
ODBC_ERROR_GENERAL_ERR	常规安装程序错误	发生错误，其中没有特定的安装程序错误。
ODBC_ERROR_INVALID_PATH	安装路径无效	lpszFileName 参数中指定的文件名路径无效。
ODBC_ERROR_INVALID_REQUEST_TYPE	请求类型无效	lpszAppName、lpszKeyName 或 lpszString 参数为 NULL。

注释

ODBC 保留用于存储连接信息的节名称 [ODBC]。 本部分的保留关键字与 SQLDriverConnect 中为连接字符串保留的关键字相同。 (有关详细信息，请参阅 SQLDriverConnect 函数 description.)

应用程序可以使用这些保留关键字将信息直接写入文件 DSN。 如果应用程序想要创建或修改与文件 DSN 关联的无 DSN 连接字符串，则可以为 [ODBC] 节中的任何保留连接字符串关键字调用 SQLWriteFileDSN 。

如果 lpszString 参数是空指针，则将从 .dsn 文件中删除 lpszKeyName 参数指向的关键字。 如果 lpszString 和 lpszKeyName 参数都是空指针，则将从 .dsn 文件中删除 lpszAppName 参数指向的部分。

相关函数

有关以下方面的信息	请参阅
从文件 DSN 读取信息	SQLReadFileDSN