GetNumberFormatA 函式 (winnls.h)

  • 發行項

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

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

語法

int GetNumberFormatA(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in]            LPCSTR           lpValue,
  [in, optional]  const NUMBERFMTA *lpFormat,
  [out, optional] LPSTR            lpNumberStr,
  [in]            int              cchNumber
);

參數

[in] Locale

指定地區設定的地區設定識別碼。 您可以使用 MAKELCID 宏來建立地區設定標識碼，或使用下列其中一個預先定義的值。

[in] dwFlags

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

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

[in] lpValue

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

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

[in, optional] lpFormat

NUMBERFMT 結構的指標，其中包含數位格式資訊，且所有成員都設定為適當的值。 如果此參數未設定為 NULL，則函式只會針對結構中未指定的格式資訊使用地區設定，例如負號的地區設定特定字串值。

[out, optional] lpNumberStr

這個函式擷取格式化數位字串的緩衝區指標。

[in] cchNumber

大小，以 TCHAR 為單位，表示 lpNumberStr 所指示的數位字串緩衝區。 或者，應用程式可以將此參數設定為 0。 在此情況下，函式會傳回數位字串緩衝區的必要大小，而且不會使用 lpNumberStr 參數。

傳回值

傳回成功時， 傳回 lpNumberStr 所指示之緩衝區中擷取的 TCHAR 值數目。 如果 cchNumber 參數設定為 0，函式會傳回保存格式化數位字串所需的字元數，包括終止的 Null 字元。

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

  • ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大，或設定為 NULL 不正確。
  • ERROR_INVALID_FLAGS。 為旗標的值無效。
  • ERROR_INVALID_PARAMETER。 任何參數值都無效。
  • ERROR_OUTOFMEMORY。 沒有足夠的記憶體可完成這項作業。

備註

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

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

注意

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

規格需求

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

另請參閱

GetNumberFormatEx

NUMBERFMT

國家語言支援

國家語言支援函式