SQLGetConfigMode 函数

一致性
引入的版本:ODBC 3.0

摘要
SQLGetConfigMode 检索配置模式,该模式指示列出 DSN 值的Odbc.ini条目在系统信息中的位置。

语法

  
BOOL SQLGetConfigMode(  
     UWORD *   pwConfigMode);  

参数

pwConfigMode
[输出]指向包含配置模式的缓冲区的指针。 (请参阅“注释”。) pwConfigMode 中的值可以是:

ODBC_USER_DSN

ODBC_SYSTEM_DSN

ODBC_BOTH_DSN

返回

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

诊断

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

*pfErrorCode 错误 说明
ODBC_ERROR_OUT_OF_MEM 内存不足 由于内存不足,安装程序无法执行该函数。

注释

此函数用于确定列出 DSN 值的Odbc.ini条目在系统信息中的位置。 如果 *pwConfigMode ODBC_USER_DSN,则 DSN 为用户 DSN,函数从HKEY_CURRENT_USER中的Odbc.ini项读取。 如果它是ODBC_SYSTEM_DSN,则 DSN 是系统 DSN,函数从HKEY_LOCAL_MACHINE中的Odbc.ini项读取。 如果ODBC_BOTH_DSN,则尝试HKEY_CURRENT_USER,如果失败,则使用HKEY_LOCAL_MACHINE。

默认情况下, SQLGetConfigMode 返回ODBC_BOTH_DSN。 通过调用 SQLConfigDataSource 创建用户 DSN 或系统 DSN 时,函数会将配置模式设置为ODBC_USER_DSN或ODBC_SYSTEM_DSN,以在修改 DSN 时区分用户和系统 DSN。 在返回之前, SQLConfigDataSource 将配置模式重置为ODBC_BOTH_DSN。

有关以下方面的信息 请参阅
设置配置模式 SQLSetConfigMode