SQLValidDSN 函数

一致性
引入的版本:ODBC 2.0

摘要
SQLValidDSN 在将数据源名称添加到系统信息之前,会检查数据源名称的长度和有效性。

语法

  
BOOL SQLValidDSN(  
     LPCSTR    lpszDSN);  

参数

lpszDSN
[输入]要检查的数据源名称。

返回

如果数据源名称有效,则函数返回 TRUE。 如果数据源名称无效或函数调用失败,则返回 FALSE。

诊断

SQLValidDSN 返回 FALSE 时,可以通过调用 SQLInstallerError 来获取关联的 *pfErrorCode 值。 仅当函数调用失败时,才会返回 *pfErrorCode ;如果由于数据源名称无效而返回 FALSE,则不返回 。 下表列出了 SQLInstallerError 可返回的 *pfErrorCode 值,并说明了此函数上下文中的每个值。

*pfErrorCode 错误 说明
ODBC_ERROR_GENERAL_ERR 常规安装程序错误 发生错误,其中没有特定的安装程序错误。
ODBC_ERROR_OUT_OF_MEM 内存不足 由于内存不足,安装程序无法执行函数。

注释

驱动程序的 ConfigDSN 调用 SQLValidDSN 来检查数据源名称的长度以及数据源名称中各个字符的有效性。 它检查名称的长度是否大于 SQL_MAX_DSN_LENGTH,如 Sqlext.h 中定义。 (SQLWriteDSNToIni.) SQLValidDSN 检查数据源名称的长度是否包含以下任何无效字符:

[ ] { } ( ) , ; ? * = ! @ \

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