getNumberFormatEx 函式 (winnls.h)
將數位字串格式化為依名稱所指定地區設定所自定義的數位字串。
語法
int GetNumberFormatEx(
[in, optional] LPCWSTR lpLocaleName,
[in] DWORD dwFlags,
[in] LPCWSTR lpValue,
[in, optional] const NUMBERFMTW *lpFormat,
[out, optional] LPWSTR lpNumberStr,
[in] int cchNumber
);
參數
[in, optional] lpLocaleName
地區設定名稱的指標,或下列其中一個預先定義的值。
[in] dwFlags
控制函式作業的旗標。 如果 lpFormat 未設定為 NULL,應用程式必須將此參數設定為 0。 在此情況下,函式會使用使用者覆寫將字串格式化為地區設定的預設數位格式。 如果 lpFormat 設定為 NULL,應用程式可以使用指定地區設定的系統預設數位格式 ,指定LOCALE_NOUSEROVERRIDE 來格式化字串。
[in] lpValue
Null 終止字串的指標,其中包含要格式化的數位字串。 此字串只能包含下列字元。 所有其他字元都無效。 如果 lpValue 所指示的字串從這些規則中偏離,此函式會傳回錯誤。
- 字元 “0” 到 “9”。
- 如果數位是浮點值,則 (點) 一個小數點。
- 如果數位為負值,則為第一個字元位置的減號。
[in, optional] lpFormat
NUMBERFMT 結構的指標,其中包含數位格式資訊,並將所有成員設定為適當的值。 如果應用程式未將此參數設定為 NULL,則函式只會使用地區設定來格式化結構中未指定的資訊,例如負號的地區設定字串值。
[out, optional] lpNumberStr
此函式擷取格式化數位字串之緩衝區的指標。 或者,如果 cchNumber 設定為 0,則此參數會包含 NULL。 在此情況下,函式會傳回數位字串緩衝區所需的大小。
[in] cchNumber
大小,以字元為單位,代表 lpNumberStr 所指示的數位字串緩衝區。 或者,應用程式可以將此參數設定為 0。 在此情況下,函式會傳回數位字串緩衝區的必要大小,而且不會使用 lpNumberStr 參數。
傳回值
如果成功,會傳回 在 lpNumberStr 所指示之緩衝區中擷取的字元數。 如果 cchNumber 參數設定為 0,函式會傳回保存格式化數位字串所需的字元數,包括終止的 Null 字元。
如果函式不成功,函式會傳回 0。 若要取得擴充的錯誤資訊,應用程式可以呼叫 GetLastError,這可以傳回下列其中一個錯誤碼:
- ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大,或設定為 NULL 不正確。
- ERROR_INVALID_FLAGS。 為旗標的值無效。
- ERROR_INVALID_PARAMETER。 任何參數值都無效。
- ERROR_OUTOFMEMORY。 沒有足夠的記憶體可完成此作業。
備註
從 Windows 8 開始:如果您的 app 從 Windows.Globalization 命名空間將語言標記傳遞至此函式,則必須先呼叫 ResolveLocaleName 來轉換標記。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | winnls.h (包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |