GetCurrencyFormatW 函式（winnls.h）

發行項
11/20/2024

將數位字串格式化為識別碼所指定地區設定的貨幣字串。

注意基於互操作性考慮，應用程式應該偏好使用 GetCurrencyFormatEx 函式來 GetCurrencyFormat，因為Microsoft正移轉至使用地區設定名稱，而不是新地區設定的地區設定標識符。只有在 Windows Vista 和更新版本上執行的任何應用程式都應該使用 GetCurrencyFormatEx。

語法

int GetCurrencyFormatW(
  [in]            LCID               Locale,
  [in]            DWORD              dwFlags,
  [in]            LPCWSTR            lpValue,
  [in, optional]  const CURRENCYFMTW *lpFormat,
  [out, optional] LPWSTR             lpCurrencyStr,
  [in]            int                cchCurrency
);

參數

[in] Locale

地區設定識別子，指定此函式格式化貨幣字串的地區設定。您可以使用 MAKELCID 巨集來建立地區設定識別碼，或使用下列其中一個預先定義的值。

[in] dwFlags

控制貨幣格式的旗標。如果 lpFormat 未設定 為 NULL，應用程式就必須將此參數設定為 0。在此情況下，函式會使用使用者覆寫將字串格式化為地區設定的預設貨幣格式。如果 lpFormat 設定為 NULL，應用程式可以使用指定地區設定的系統預設貨幣格式來指定字串格式 LOCALE_NOUSEROVERRIDE。

警告使用 LOCALE_NOUSEROVERRIDE 強烈建議您停用使用者喜好設定。

[in] lpValue

如需詳細資訊，請參閱 getCurrencyFormatExlpValue 參數。

[in, optional] lpFormat

包含貨幣格式資訊的 CURRENCYFMT 結構的指標。結構的所有成員都必須包含適當的值。如果 function 是使用指定地區設定的貨幣格式，應用程式可以將此參數設定為 NULL。如果此參數未設定為 NULL，則函式只會使用指定的地區設定來格式化 CURRENCYFMT 結構中指定的資訊，例如地區設定所使用的負號字元串值。

[out, optional] lpCurrencyStr

這個函式擷取格式化貨幣字串之緩衝區的指標。

[in] cchCurrency

大小，以字元為單位，lpCurrencyStr 緩衝區。如果函式傳回保存格式化貨幣字串所需的緩衝區大小，應用程式會將此參數設定為 0。在此情況下，不會使用 lpCurrencyStr 參數。

傳回值

傳回在緩衝區中擷取的字元數，如果成功，lpCurrencyStr。如果 cchCurrency 參數設定為 0，則函式會傳回保存格式化貨幣字串所需的緩衝區大小，包括終止的 Null 字元。

如果函式未成功，則傳回 0。若要取得擴充的錯誤資訊，應用程式可以呼叫 getLastError，以傳回下列其中一個錯誤碼：

ERROR_INSUFFICIENT_BUFFER。提供的緩衝區大小不夠大，或設定為 NULL不正確。
ERROR_INVALID_FLAGS。為旗標的值無效。
ERROR_INVALID_PARAMETER。任何參數值都無效。

言論

此函式可以從自定義地區設定擷取數據。數據不保證會從計算機到計算機，或在應用程式執行之間相同。如果您的應用程式必須儲存或傳輸資料，請參閱使用永續性地區設定資料。

當此函式的 ANSI 版本與僅限 Unicode 的地區設定識別碼搭配使用時，呼叫可能會成功，因為操作系統會使用系統代碼頁。不過，系統代碼頁中未定義的字元會以問號（？）的形式出現在字串中。

注意

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

要求

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