GetCurrencyFormatA 函式 (winnls.h)

  • 發行項

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

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

語法

int GetCurrencyFormatA(
  [in]            LCID               Locale,
  [in]            DWORD              dwFlags,
  [in]            LPCSTR             lpValue,
  [in, optional]  const CURRENCYFMTA *lpFormat,
  [out, optional] LPSTR              lpCurrencyStr,
  [in]            int                cchCurrency
);

參數

[in] Locale

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

[in] dwFlags

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

謹慎 強烈建議不要使用 LOCALE_NOUSEROVERRIDE ，因為它會停用使用者喜好設定。
 

[in] lpValue

如需詳細資訊，請參閱GetCurrencyFormatEx的lpValue參數。

[in, optional] lpFormat

包含貨幣格式資訊的 CURRENCYFMT 結構的指標。 結構的所有成員都必須包含適當的值。 如果函式是使用指定地區設定的貨幣格式，應用程式可以將此參數設定為 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 標頭會將 GetCurrencyFormat 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

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

另請參閱

CURRENCYFMT

GetCurrencyFormatEx

GetNumberFormat

國家語言支援

國家語言支援函式