GetCurrencyFormatEx

Formats a number string as a currency string for a locale specified by name.

Note

The application should call this function in preference to GetCurrencyFormat if designed to run only on Windows Vista and later.
Note

This function can format data that changes between releases, for example, due to a custom locale. If your application must persist or transmit data, see Using Persistent Locale Data.

Syntax

int GetCurrencyFormatEx(
         LPCWSTR lpLocaleName,
         DWORD dwFlags,
         LPCWSTR lpValue,
         const CURRENCYFMTW *lpFormat,
         _Out_writes_opt_(cchCurrency)LPWSTR lpCurrencyStr,
         int cchCurrency
)  

Parameters

lpLocaleName
Type: LPCWSTR 

Pointer to a locale name or one of the following predefined values.

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

dwFlags
Type: DWORD 

Flags controlling the operation of the function. The application must set this parameter to 0 if lpFormat is not set to NULL. In this case, the function formats the string using user overrides to the default currency format for the locale. If lpFormat is set to NULL, the application can specify LOCALE_NOUSEROVERRIDE to format the string using the system default currency format for the specified locale.

Caution

  Use of LOCALE_NOUSEROVERRIDE is strongly discouraged as it disables user preferences.

lpValue
Type: LPCWSTR 

Pointer to a null-terminated string containing 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 deviates from these rules.

• 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

lpFormat
Type: CURRENCYFMTW *

Pointer to a CURRENCYFMT structure that contains currency formatting information. All members of the structure must contain appropriate values. The application can set this parameter to NULL if function is to use the currency format of the specified locale. If this parameter is not set to NULL, the function uses the specified locale only for formatting information not specified in the CURRENCYFMT structure, for example, the string value for the negative sign used by the locale.

lpCurrencyStr
Type: Out_writes_opt(cchCurrency)LPWSTR 

Pointer to a buffer in which this function retrieves the formatted currency string.

cchCurrency
Type: int 

Size, in characters, of the lpCurrencyStr buffer. The application can set this parameter to 0 to return the size of the buffer required to hold the formatted currency string. In this case, the buffer indicated by lpCurrencyStr is not used.

Return value

Type: int 

Returns the number of characters retrieved in the buffer indicated by lpCurrencyStr if successful. If the cchCurrency parameter is 0, the function returns the size of the buffer required to hold the formatted currency string, including a terminating null character.

The function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which can return one of the following error codes:

• ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL.
• ERROR_INVALID_FLAGS. The values supplied for flags were not valid.
• ERROR_INVALID_PARAMETER. Any of the parameter values was invalid.

Remarks

Beginning in Windows 8: If your app passes language tags to this function from the Windows.Globalization namespace, it must first convert the tags by calling ResolveLocaleName.

Windows Phone 8: This API is supported.

Requirements

Header: Declared in winnls.h.

Library: Use kernelx.lib.