Share via


writeProfileStringA 函式 (winbase.h)

將字串複製到 Win.ini 檔案的指定區段。 如果 Win.ini 使用 Unicode 字元,函式會將 Unicode 字元寫入檔案。 否則,函式會寫入 ANSI 字元。

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

語法

BOOL WriteProfileStringA(
  [in] LPCSTR lpAppName,
  [in] LPCSTR lpKeyName,
  [in] LPCSTR lpString
);

參數

[in] lpAppName

要複製字串的區段。 如果區段不存在,則會建立它。 區段的名稱不區分大小寫;字串可以是大寫和小寫字母的任何組合。

[in] lpKeyName

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

[in] lpString

要寫入檔案的 Null 終止字串。 如果此參數為 NULL,則會刪除 lpKeyName 參數所指向的索引鍵。

傳回值

如果函式成功將字串複製到 Win.ini 檔案,則傳回值為非零值。

如果函式失敗,或它會排清快取版本的 Win.ini,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError

備註

Win.ini 檔案中的區段必須具有下列格式: 索引鍵=字串

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

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

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows NT
            CurrentVersion
               IniFileMapping

當作業對應時, WriteProfileString 函式會將資訊寫入登錄,而不是初始化檔案;儲存位置中的變更不會影響函式的行為。

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

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

規格需求

需求
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 winbase.h (包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

GetProfileString

WritePrivateProfileString