This function formats a number string as a currency string for a specified locale.
At a Glance
| Header file: | Winnls.h |
| Windows CE versions: | 1.0 and later |
Syntax
int GetCurrencyFormat(LCID Locale, DWORD dwFlags,
LPCTSTR lpValue, const CURRENCYFMT *lpFormat,
LPTSTR lpCurrencyStr, int cchCurrency);
Parameters
Locale
[in] Specifies the locale for which the currency string is to be formatted. If lpFormat is NULL, the function formats the string according to the currency format for this locale. If lpFormat is not NULL, the function uses the locale only for formatting information not specified in the CURRENCYFMT 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:
| Value | Description |
| LOCALE_SYSTEM_DEFAULT | Default system locale. |
| LOCALE_USER_DEFAULT | Default user locale. |
| LOCALE_NEUTRAL | Default language-neutral locale. |
dwFlags
[in] 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 currency format for the specified locale; or you can specify zero to format the string using any user overrides to the locale's default currency format.
lpValue
[in] Pointer to a null-terminated string that contains the number string to format.
This string can contain only the following characters:
All other characters are invalid. The function returns an error if the string pointed to by lpValue deviates from these rules.
lpFormat
[in] Pointer to a CURRENCYFMT structure that contains currency formatting information. All members in the structure pointed to by lpFormat must contain appropriate values.
If lpFormat is NULL, the function uses the currency format of the specified locale.
lpCurrencyStr
[out] Pointer to a buffer to receive the formatted currency string.
cchCurrency
[in] Specifies the size, in characters, of the lpCurrencyStr buffer. If cchCurrency is zero, the function returns the number of bytes or characters required to hold the formatted currency string, and the buffer pointed to by lpCurrencyStr is not used.
Return Values
The number of characters written to the buffer pointed to by lpCurrencyStr, or, if the cchCurrency parameter is zero, the number of characters required to hold the formatted currency string indicates success. The count includes the terminating null. Zero indicates failure. To get extended error information, call GetLastError. Possible values for GetLastError include the following:
See Also