共用方式為

SQLGetPrivateProfileString 函式

  • 發行項

一致性
引進的版本：ODBC 2.0

摘要
SQLGetPrivateProfileString 會取得對應至系統資訊值的值或數據名稱清單。

語法

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);

引數

lpszSection
[輸入]指向以 Null 結尾的字串，指定包含索引鍵名稱的區段。 如果這個自變數為 NULL，函式會將檔案中的所有區段名稱複製到提供的緩衝區。

lpszEntry
[輸入]指向包含要擷取相關聯字串之索引鍵名稱的 Null 終止字串。 如果這個自變數為 NULL，則 lpszSection 自變數所指定區段中的所有索引鍵名稱都會複製到 RetBuffer 自變數所指定的緩衝區。

lpszDefault
[輸入]指向 Null 終止的字串，指定在初始化檔案中找不到索引鍵時，指定指定索引鍵的預設值。 這個自變數不可以是 NULL。

RetBuffer
[輸出]指向接收所擷取字串的緩衝區。

cbRetBuffer
[輸入]指定 RetBuffer 自變數所指向之緩衝區的大小，以字元為單位。

lpszFilename
[輸入]指向為初始化檔案命名的 Null 終止字串。 如果這個自變數不包含檔案的完整路徑，則會搜尋預設目錄。

傳回

SQLGetPrivateProfileString 會傳回整數值，指出讀取的字元數。

診斷

呼叫 SQLGetPrivateProfileString 失敗時，呼叫 SQLInstallerError 來取得相關聯的 *pfErrorCode 值。 下表列出 SQLInstallerError 可傳回的 *pfErrorCode 值，並說明此函式內容中的每個值。

*pfErrorCode 錯誤 描述
ODBC_ERROR_GENERAL_ERR 一般安裝程序錯誤 發生錯誤，沒有特定的安裝程序錯誤。
ODBC_ERROR_OUT_OF_MEM 記憶體不足 由於記憶體不足，安裝程式無法執行函式。

註解

SQLGetPrivateProfileString 是以將驅動程式和驅動程式設定 DLL 從 Microsoft Windows 移植到 Microsoft Windows NT/Windows 2000 的簡單方式提供。 從Odbc.ini檔案擷取配置檔字串的 GetPrivateProfileString 呼叫，應該取代為對 SQLGetPrivateProfileString 的呼叫。 SQLGetPrivateProfileString 會呼叫 Win32 API 中的函式，以擷取對應至系統資訊之Odbc.ini子機碼的值所要求的值或數據名稱。

組態模式（如 SQLSetConfigMode 所設定）指出系統資訊中列出 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。

如需下列資訊 請參閱
將值寫入系統資訊 SQLWritePrivateProfileString