SQLWritePrivateProfileString 函式
一致性
引進的版本:ODBC 2.0
摘要
SQLWritePrivateProfileString 會將值名稱和數據寫入系統資訊的Odbc.ini子機碼。
語法
BOOL SQLWritePrivateProfileString(
LPCSTR lpszSection,
LPCSTR lpszEntry,
LPCSTR lpszString,
LPCSTR lpszFilename);
引數
lpszSection
[輸入]指向以 Null 結尾的字串,其中包含將複製字串之區段的名稱。 如果區段不存在,則會建立該區段。 區段的名稱與大小寫無關;字串可以是大寫和小寫字母的任何組合。
lpszEntry
[輸入]指向包含要與字串相關聯之索引鍵名稱的 Null 終止字串。 如果索引鍵不存在於指定的區段中,則會建立它。 如果這個自變數為 NULL,則會刪除整個區段,包括 區段內的所有專案。
lpszString
[輸入]指向要寫入檔案的 Null 終止字串。 如果這個自變數為 NULL,則會刪除 lpszEntry 自變數所指向的索引鍵。
lpszFilename
[輸出]指向為初始化檔案命名的 Null 終止字串。
傳回
如果函式成功,則傳回 TRUE,如果失敗,則傳回 FALSE。
診斷
當 SQLWritePrivateProfileString 傳回 FALSE 時,可以呼叫 SQLInstallerError 來取得相關聯的 *pfErrorCode 值。 下表列出 SQLInstallerError 可傳回的 *pfErrorCode 值,並說明此函式內容中的每個值。
*pfErrorCode | 錯誤 | 描述 |
---|---|---|
ODBC_ERROR_GENERAL_ERR | 一般安裝程序錯誤 | 發生錯誤,沒有特定的安裝程序錯誤。 |
ODBC_ERROR_REQUEST_FAILED | 要求失敗 | 無法寫入要求的系統資訊。 |
ODBC_ERROR_OUT_OF_MEM | 記憶體不足 | 由於記憶體不足,安裝程式無法執行函式。 |
註解
SQLWritePrivateProfileString 是以將驅動程式和驅動程式設定 DLL 從 Microsoft Windows 移植到 Microsoft Windows NT/Windows 2000 的簡單方式提供。 呼叫 WritePrivateProfileString,以呼叫 SQLWritePrivateProfileString,將配置檔字串寫入Odbc.ini檔案。 SQLWritePrivateProfileString 會呼叫 Win32 API 中的函式,將指定的值名稱和數據新增至系統資訊的Odbc.ini子機碼。
組態模式表示列出 DSN 值的Odbc.ini項目位於系統資訊的位置。 如果 DSN 是使用者 DSN(狀態變數為USERDSN_ONLY),函式會寫入HKEY_CURRENT_USER中的Odbc.ini專案。 如果 DSN 是系統 DSN (SYSTEMDSN_ONLY),函式會寫入HKEY_LOCAL_MACHINE中的Odbc.ini專案。 如果狀態變數是 BOTHDSN,則會嘗試HKEY_CURRENT_USER,如果失敗,則會使用HKEY_LOCAL_MACHINE。
相關函數
如需下列資訊 | 請參閱 |
---|---|
從系統資訊取得值 | SQLGetPrivateProfileString |