getPrivateProfileStructA 函式 (winbase.h)
擷取初始化檔案之指定區段中與索引鍵相關聯的數據。 當它擷取數據時，函式會計算總和檢查碼，並在將數據新增至檔案時，與 WritePrivateProfileStruct 函式所計算的總和檢查碼進行比較。
語法
BOOL GetPrivateProfileStructA(
[in] LPCSTR lpszSection,
[in] LPCSTR lpszKey,
[out] LPVOID lpStruct,
[in] UINT uSizeStruct,
[in] LPCSTR szFile
);
參數
[in] lpszSection
初始化檔案中區段的名稱。
[in] lpszKey
要擷取其數據的索引鍵名稱。
[out] lpStruct
緩衝區的指標，接收與檔案、區段和索引鍵名稱相關聯的數據。
[in] uSizeStruct
lpStruct 參數所指向的緩衝區大小，以位元組為單位。
[in] szFile
初始化檔案的名稱。 如果此參數不包含檔案的完整路徑，系統會搜尋 Windows 目錄中的檔案。
傳回值
如果函式成功，則傳回非零的值。
如果此函式失敗，則傳回值為零。
備註
初始化檔案中的區段必須具有下列格式：
[section]
key=data
.
.
.
系統會使用下列登錄機碼下定義的對應，將大部分 .ini 檔案參考對應至登錄：HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping
如果應用程式修改系統元件初始化檔案，例如 Control.ini、System.ini 和 Winfile.ini，則可能是這種對應。 在這些情況下，函式會從登錄擷取資訊，而不是從初始化檔案擷取資訊;儲存位置中的變更不會影響函式的行為。
設定檔案函式會使用下列步驟來尋找初始化資訊：
- 在登錄中尋找初始化檔案的名稱，例如 iniFileMapping 底下 MyFile.ini。
- 尋找 lpAppName 所指定的區段名稱。 這會是 myfile.ini下的具名值，或是 myfile.ini的子機碼，或不存在。
- 如果 lpAppName 指定的區段名稱是 myfile.ini下的具名值，則該值會指定登錄中您會找到區段索引鍵的位置。
- 如果 lpAppName 指定的區段名稱是 myfile.ini的子機碼，則該子機碼底下的具名值會指定您在登錄中找到區段的機碼。 如果您要尋找的機碼不存在為具名值，則會有未命名的值， (顯示為 <[無名稱> ]) ，指定您在登錄中找到密鑰的預設位置。
- 如果 lpAppName 指定的區段名稱不存在為具名值或 myfile.ini底下的子機碼，則 (在 [myfile.ini] 底下顯示為 <[無名稱>]) ，指定您在登錄中找到區段索引鍵的預設位置。
- 如果沒有 myfile.ini 子機碼，或未包含區段名稱的專案，請在磁碟上尋找實際的 MyFile.ini，並讀取其內容。
- ! - 此字元會強制所有寫入至登錄和磁碟上 .ini 檔案。
- # - 當新使用者第一次在安裝之後登入時，此字元會使登錄值設定為 Windows 3.1 .ini 檔案中的值。
- @ - 如果登錄中找不到要求的數據，此字元可防止任何讀取移至磁碟上的 .ini 檔案。
- USR：此前置詞代表 HKEY_CURRENT_USER，而前置詞之後的文字則代表該索引鍵的相對。
- SYS：- 此前置詞代表 HKEY_LOCAL_MACHINE\SOFTWARE，而前置詞之後的文字會相對於該索引鍵。
注意
winbase.h 標頭會將 GetPrivateProfileStruct 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
| 目標平台 | Windows |
| 標頭 | winbase.h (包含 Windows.h) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |