GetNumberFormat
The GetNumberFormat
function formats a number string as a number string customized for a specified
locale.
int GetNumberFormat(
|
LCID Locale, |
// locale for which
number string is to be formatted |
|
DWORD dwFlags, |
// bit flag that
controls the function s operation |
|
LPCTSTR lpValue, |
// pointer to input
number string |
|
CONST NUMBERFMT *lpFormat, |
// pointer to a
formatting information structure |
|
LPTSTR lpNumberStr, |
// pointer to
output buffer |
|
int cchNumber |
// size of output
buffer |
|
); |
|
Parameters
Locale
Specifies the
locale for which the number string is to be formatted. If lpFormat is
NULL, the function formats the string according to the number format for this
locale. If lpFormat is not NULL, the function uses the locale only for
formatting information not specified in the NUMBERFMT structure (for example, the
locale s string value for the negative sign).
This
parameter can be a locale identifier created by the MAKELCID macro, or one of the
following predefined values:
|
LOCALE_SYSTEM_DEFAULT |
Default
system locale. |
|
LOCALE_USER_DEFAULT |
Default
user locale. |
dwFlags
Contains a
bit flag that controls the operation of the function. If lpFormat is
non-NULL, this parameter must be zero.
If lpFormat
is NULL, you can specify the LOCALE_NOUSEROVERRIDE flag to format the string
using the system default number format for the specified locale; or you can
specify zero to format the string using any user overrides to the locale s
default number format
lpValue
Points to a
null-terminated string containing the number string to format.
This string
can only contain the following characters:
Characters 0 through 9
One decimal point (dot) if the number is a
floating-point value
A minus sign in the first character position
if the number is a negative value
All other
characters are invalid. The function returns an error if the string pointed to
by lpValue deviates from these rules.
lpFormat
Pointer to a NUMBERFMT structure that contains
number formatting information. All members in the structure pointed to by lpFormat
must contain appropriate values.
If lpFormat
is NULL, the function uses the number format of the specified locale.
lpNumberStr
Points to a
buffer to receive the formatted number string.
cchNumber
Specifies the
size, in bytes (ANSI version) or characters (Unicode version), of the lpNumberStr
buffer. If cchNumber is zero, the function returns the number of bytes
or characters required to hold the formatted number string, and the buffer
pointed to by lpNumberStr is not used.
Return Values
If the
function succeeds, the return value is the number of bytes (ANSI version) or
characters (Unicode version) written to the buffer pointed to by lpNumberStr,
or if the cchNumber parameter is zero, the number of bytes or characters
required to hold the formatted number string.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
GetLastError may return one of the following error codes:
ERROR_INSUFFICIENT_BUFFER
ERROR_INVALID FLAGS
ERROR_INVALID_PARAMETER
See Also