SQLWriteDSNToIni 函式
一致性
引進的版本:ODBC 1.0
摘要
SQLWriteDSNToIni 會將資料來源新增至系統資訊。
語法
BOOL SQLWriteDSNToIni(
LPCSTR lpszDSN,
LPCSTR lpszDriver);
引數
lpszDSN
[輸入]要加入的資料來源名稱。
lpszDriver
[輸入]驅動程式描述(通常是相關聯的 DBMS 名稱)向使用者呈現,而不是實體驅動程式名稱。
傳回
如果函式成功,則傳回 TRUE,如果失敗,則傳回 FALSE。
診斷
當 SQLWriteDSNToIni 傳回 FALSE 時 ,可以呼叫 SQLInstallerError 來取得相關聯的 *pfErrorCode 值。 下表列出 SQLInstallerError 可傳 回的 *pfErrorCode 值,並說明此函式內容中的每個值。
*pfErrorCode | 錯誤 | 描述 |
---|---|---|
ODBC_ERROR_GENERAL_ERR | 一般安裝程式錯誤 | 發生錯誤,沒有特定的安裝程式錯誤。 |
ODBC_ERROR_INVALID_DSN | 不正確 DSN | lpszDSN 引數包含 DSN 不正確字串。 |
ODBC_ERROR_INVALID_NAME | 不正確驅動程式或翻譯工具名稱 | lpszDriver 引數無效。 |
ODBC_ERROR_REQUEST_FAILED | 要求失敗 | 安裝程式無法在登錄中建立 DSN。 |
ODBC_ERROR_OUT_OF_MEM | 記憶體不足 | 由於記憶體不足,安裝程式無法執行函式。 |
註解
SQLWriteDSNToIni 會將資料來源新增至系統資訊的 [ODBC 資料來源] 區段。 然後,它會建立資料來源的規格區段,並新增具有驅動程式 DLL 名稱的單一關鍵字 ( Driver ) 作為其值。 如果資料來源規格區段已經存在, SQLWriteDSNToIni 會先移除舊區段,再建立新的區段。
此函式的呼叫端必須將任何驅動程式特定的關鍵字和值新增至系統資訊的資料來源規格區段。
如果資料來源的名稱是 Default, SQLWriteDSNToIni 也會在系統資訊中建立預設驅動程式規格區段。
此函式只能從安裝 DLL 呼叫。
相關函數
如需下列資訊 | 請參閱 |
---|---|
新增、修改或移除資料來源 | ConfigDSN (在安裝 DLL 中) |
新增、修改或移除資料來源 | SQLConfigDataSource |
從系統資訊中移除資料來源名稱 | SQLRemoveDSNFromIni |