共用方式為

WritePrivateProfileStructA 函式 （winbase.h）

  • 發行項

將數據複製到初始化檔案指定區段中的索引鍵。 當數據複製時，函式會計算總和檢查碼，並將它附加至數據結尾。 GetPrivateProfileStruct 函式會使用總和檢查碼來確保數據的完整性。

注意 此函式僅供與 16 位版本的 Windows 相容。 應用程式應該將初始化資訊儲存在登錄中。
 

語法

BOOL WritePrivateProfileStructA(
  [in] LPCSTR lpszSection,
  [in] LPCSTR lpszKey,
  [in] LPVOID lpStruct,
  [in] UINT   uSizeStruct,
  [in] LPCSTR szFile
);

參數

[in] lpszSection

將複製字串的區段名稱。 如果區段不存在，則會建立該區段。 區段的名稱與大小寫無關，字串可以是大寫和小寫字母的任何組合。

[in] lpszKey

要與字串相關聯的索引鍵名稱。 如果索引鍵不存在於指定的區段中，則會建立它。 如果此參數 NULL，則會刪除整個區段，包括區段內的所有索引鍵和專案。

[in] lpStruct

要複製的數據。 如果此參數 NULL，則會刪除密鑰。

[in] uSizeStruct

lpStruct 參數所指向的緩衝區大小，以位元組為單位。

[in] szFile

初始化檔的名稱。 如果此參數 NULL，則會將資訊複製到 Win.ini 檔案中。

如果使用 Unicode 字元建立檔案，函式會將 Unicode 字元寫入檔案。 否則，函式會寫入 ANSI 字元。

傳回值

如果函式成功將字串複製到初始化檔案，則傳回值為非零值。

如果函式失敗，或它會排清最近存取之初始化檔案的快取版本，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

言論

初始化檔案中的區段必須具有下列格式：

[section]
key=string
      .
      .
      .

如果 szFile 參數未包含檔案的完整路徑和檔名，WritePrivateProfileString 搜尋 Windows 目錄的檔案。 如果檔案不存在，此函式會在 Windows 目錄中建立檔案。

如果 szFile 包含完整路徑和檔名，且檔案不存在，WriteProfileString 建立檔案。 指定的目錄必須已經存在。

系統會保留最新登錄檔對應的快取版本，以改善效能。 如果所有參數都 NULL，則函式會排清快取。 當系統正在編輯檔案的快取版本時，編輯檔案本身的程式將會使用源檔，直到清除快取為止。

系統會使用下列登錄機碼下定義的對應，將大部分 .ini 檔案參考對應至登錄：

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows NT
            CurrentVersion
               IniFileMapping

如果應用程式修改系統元件初始化檔案，例如 Control.ini、System.ini和 Winfile.ini，則此對應可能會是 。 在此情況下，函式會將資訊寫入登錄，而不是初始化檔案;儲存位置的變更不會影響函式的行為。

設定檔案函式會使用下列步驟來找出初始化資訊：

  1. 在登錄中查看 iniFileMapping 機碼底下的初始化檔名。
  2. 尋找 lpAppName所指定的區段名稱。 這會是索引鍵底下的具名值，該索引鍵具有初始化檔的名稱，或是具有此名稱的子機碼，或名稱不會以值或子機碼的形式存在。
  3. 如果 lpAppName 所指定的區段名稱 是具名值，則該值會指定登錄中您會找到區段索引鍵的位置。
  4. 如果 lpAppName 所指定的區段名稱 為子機碼，則該子機碼底下的具名值會指定登錄中的位置，您會找到區段的機碼。 如果您要尋找的機碼不存在為具名值，則會有未命名的值（如 <無名稱>），指定您在登錄中找到密鑰的預設位置。
  5. 如果 lpAppName 所指定的區段名稱 不存在為具名值或子機碼，則會有一個未命名的值（如 <無名稱>），指定您在登錄中尋找區段索引鍵的預設位置。
  6. 如果區段名稱沒有子機碼或專案，請尋找磁碟上的實際初始化檔案，並讀取其內容。
查看指定其他登錄位置的登錄值時，有數個前置詞會變更 .ini 檔案對應的行為：
  • ! - 此字元會強制所有寫入到登錄和磁碟上的 .ini 檔案。
  • # - 此字元會在安裝後第一次登入時，將登錄值設定為 Windows 3.1 .ini 檔案中的值。
  • @ - 如果登錄中找不到要求的數據，此字元可防止任何讀取到磁碟上的 .ini 檔案。
  • USR：- 此前置詞代表 HKEY_CURRENT_USER，而前置詞之後的文字則與該索引鍵相對。
  • SYS：- 此前置詞代表 HKEY_LOCAL_MACHINE\SOFTWARE，而前置詞之後的文字則與該索引鍵相對。

注意

winbase.h 標頭會根據 UNICODE 預處理器常數的定義，將 WritePrivateProfileStruct 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱函式原型的 慣例。

要求

要求 價值
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
支援的最低伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平臺 窗戶
標頭 winbase.h （包括 Windows.h）
連結庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

GetPrivateProfileString

WriteProfileString