SQLSetConfigMode 函式
一致性
引進的版本:ODBC 3.0
摘要
SQLSetConfigMode 會設定組態模式,指出 ODBC.ini 專案清單 DSN 值在系統資訊中的位置。
語法
BOOL SQLSetConfigMode(
UWORD wConfigMode);
引數
wConfigMode
[輸入]安裝程式設定模式(請參閱。 wConfigMode 中的 值可以是:
ODBC_USER_DSN
ODBC_SYSTEM_DSN
ODBC_BOTH_DSN
傳回
如果函式成功,則傳回 TRUE,如果失敗,則傳回 FALSE。
診斷
當 SQLSetConfigMode 傳回 FALSE 時 ,可以呼叫 SQLInstallerError 來取得相關聯的 *pfErrorCode 值。 下表列出 SQLInstallerError 可傳 回的 *pfErrorCode 值,並說明此函式內容中的每個值。
*pfErrorCode | 錯誤 | 描述 |
---|---|---|
ODBC_ERROR_INVALID_PARAM_SEQUENCE | 不正確參數序列 | wConfigMode 引數不包含ODBC_USER_DSN、ODBC_SYSTEM_DSN或ODBC_BOTH_DSN。 |
註解
此函式可用來設定 ODBC.ini 專案清單 DSN 值在系統資訊中的位置。 如果 wConfigMode 是ODBC_USER_DSN,DSN 是 User DSN,且函式會從 HKEY_CURRENT_USER 的 Odbc.ini 專案讀取。 如果ODBC_SYSTEM_DSN,DSN 是 System DSN,且函式會從 HKEY_LOCAL_MACHINE 的 Odbc.ini 專案讀取。 如果ODBC_BOTH_DSN,則會嘗試HKEY_CURRENT_USER,如果失敗,則會使用HKEY_LOCAL_MACHINE。
此函式不會影響 SQLCreateDataSource 和 SQLDriverConnect 。 當驅動程式呼叫 SQLGetPrivateProfileString 或呼叫 SQLWritePrivateProfileString 寫入登錄時,必須設定組態模式。 呼叫 SQLGetPrivateProfileString 和 SQLWritePrivateProfileString 會使用組態模式來知道登錄的哪個部分運作。
警告
SQLSetConfigMode 應該只在必要時呼叫;如果設定模式不正確,ODBC 安裝程式可能無法正常運作。
SQLSetConfigMode 會直接修改組態模式。 這與呼叫 SQLConfigDataSource 修改組態模式的程式不同。 對 SQLConfigDataSource 的 呼叫會設定設定模式,以在修改 DSN 時區分使用者和系統 DSN。 在傳回之前, SQLConfigDataSource 會將設定模式重設為 BOTHDSN。
相關函數
如需下列資訊 | 請參閱 |
---|---|
建立資料來源 | SQLCreateDataSource |
使用連接字串或對話方塊連接到資料來源 | SQLDriverConnect |
擷取組態模式 | SQLGetConfigMode |