GetCurrencyFormatEx 函式 (winnls.h)

  • 發行項

將數位字串格式化為名稱所指定地區設定的貨幣字串。

注意 如果設計為只在 Windows Vista 和更新版本上執行，應用程式應該優先呼叫 GetCurrencyFormat 這個函式。

 
注意 此函式可以格式化版本之間變更的資料，例如，因為自訂地區設定。 如果您的應用程式必須保存或傳輸資料，請參閱 使用持續性地區設定資料。
 

語法

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

參數

[in, optional] lpLocaleName

地區設定名稱的指標或下列其中一個預先定義的值。

[in] dwFlags

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

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

[in] lpValue

Null 終止字串的指標，其中包含要格式化的數位字串。 此字串只能包含下列字元。 所有其他字元都無效。 如果字串偏離這些規則，此函式會傳回錯誤。

  • 字元 「0」 到 「9」
  • 如果數位是浮點值，則 (點) 一個小數點
  • 如果數位為負值，則為第一個字元位置的減號

[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。 任何參數值都無效。

備註

從 Windows 8 開始： 如果您的 app 會從 Windows.Globalization 命名空間將語言標記傳遞至此函式，則必須先呼叫 ResolveLocaleName來轉換標記。

規格需求

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

另請參閱

CURRENCYFMT

GetCurrencyFormat

GetNumberFormatEx

國家語言支援

國家語言支援函式