Scroll to navigation

GetNumberFormatA(3w) Wine API GetNumberFormatA(3w)

NAME

GetNumberFormatA (KERNEL32.@)

SYNOPSIS

INT GetNumberFormatA
(
LCID lcid,
DWORD dwFlags,
LPCSTR lpszValue,
const NUMBERFMTA* lpFormat,
LPSTR lpNumberStr,
int cchOut
)
 

DESCRIPTION

Format a number string for a given locale.
 

PARAMS

lcid [In] Locale to format for.
dwFlags [In] LOCALE_ flags from "winnls.h".
lpszValue [In] String to format.
lpFormat [In] Formatting overrides.
lpNumberStr [Out] Destination for formatted string.
cchOut [In] Size of lpNumberStr, or 0 to calculate the resulting size.
 

NOTES

- lpszValue can contain only '0' - '9', '-' and '.'.
- If lpFormat is non-NULL, dwFlags must be 0. In this case lpszValue will be formatted according to the format details returned by GetLocaleInfoA(3w).
- This function rounds the number string if the number of decimals exceeds the locales normal number of decimal places.
- If cchOut is 0, this function does not write to lpNumberStr.
- The Ascii version of this function fails if lcid is Unicode only.
 

RETURNS

Success: The number of character written to lpNumberStr, or that would have been written, if cchOut is 0.
Failure: 0. Use GetLastError(3w) to determine the cause.
 

IMPLEMENTATION

Declared in "winnls.h".
Implemented in "dlls/kernel32/lcformat.c".
Debug channel "nls".
Oct 2012 Wine API