ucurr.h File Reference

C API: Encapsulates information about a currency. More...

#include "unicode/utypes.h"
#include "unicode/uenum.h"

Go to the source code of this file.

Typedefs
typedef enum UCurrNameStyle	UCurrNameStyle
	Selector constants for ucurr_getName().
typedef const void *	UCurrRegistryKey
typedef enum UCurrCurrencyType	UCurrCurrencyType
	Selector constants for ucurr_openCurrencies().
Enumerations
enum	UCurrNameStyle { UCURR_SYMBOL_NAME, UCURR_LONG_NAME }
	Selector constants for ucurr_getName(). More...
enum	UCurrCurrencyType {   UCURR_ALL = INT32_MAX, UCURR_COMMON = 1, UCURR_UNCOMMON = 2, UCURR_DEPRECATED = 4,   UCURR_NON_DEPRECATED = 8 }
	Selector constants for ucurr_openCurrencies(). More...
Functions
U_STABLE int32_t U_EXPORT2	ucurr_forLocale (const char *locale, UChar *buff, int32_t buffCapacity, UErrorCode *ec)
	Finds a currency code for the given locale.
U_STABLE UCurrRegistryKey U_EXPORT2	ucurr_register (const UChar *isoCode, const char *locale, UErrorCode *status)
	Register an (existing) ISO 4217 currency code for the given locale.
U_STABLE UBool U_EXPORT2	ucurr_unregister (UCurrRegistryKey key, UErrorCode *status)
	Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_register.
U_STABLE const UChar *U_EXPORT2	ucurr_getName (const UChar *currency, const char *locale, UCurrNameStyle nameStyle, UBool *isChoiceFormat, int32_t *len, UErrorCode *ec)
	Returns the display name for the given currency in the given locale.
U_DRAFT int32_t U_EXPORT2	ucurr_getDefaultFractionDigits (const UChar *currency, UErrorCode *ec)
	Returns the number of the number of fraction digits that should be displayed for the given currency.
U_DRAFT double U_EXPORT2	ucurr_getRoundingIncrement (const UChar *currency, UErrorCode *ec)
	Returns the rounding increment for the given currency, or 0.0 if no rounding is done by the currency.
U_DRAFT UEnumeration *U_EXPORT2	ucurr_openISOCurrencies (uint32_t currType, UErrorCode *pErrorCode)
	Provides a UEnumeration object for listing ISO-4217 codes.

---

Detailed Description

C API: Encapsulates information about a currency.

Definition in file ucurr.h.

---

Typedef Documentation

typedef enum UCurrCurrencyType UCurrCurrencyType

Selector constants for ucurr_openCurrencies(). See also: ucurr_openCurrencies Draft: This API may be changed in the future versions and was introduced in ICU 3.2

typedef enum UCurrNameStyle UCurrNameStyle

Selector constants for ucurr_getName(). See also: ucurr_getName Stable: ICU 2.6

typedef const void* UCurrRegistryKey

Internal: Do not use. This API is for interal use only. Definition at line 84 of file ucurr.h.

---

Enumeration Type Documentation

enum UCurrCurrencyType

Selector constants for ucurr_openCurrencies(). See also: ucurr_openCurrencies Draft: This API may be changed in the future versions and was introduced in ICU 3.2 Enumerator: UCURR_ALL  Select all ISO-4217 currency codes. Draft: This API may be changed in the future versions and was introduced in ICU 3.2 UCURR_COMMON  Select only ISO-4217 commonly used currency codes. These currencies can be found in common use, and they usually have bank notes or coins associated with the currency code. This does not include fund codes, precious metals and other various ISO-4217 codes limited to special financial products. Draft: This API may be changed in the future versions and was introduced in ICU 3.2 UCURR_UNCOMMON  Select ISO-4217 uncommon currency codes. These codes respresent fund codes, precious metals and other various ISO-4217 codes limited to special financial products. A fund code is a monetary resource associated with a currency. Draft: This API may be changed in the future versions and was introduced in ICU 3.2 UCURR_DEPRECATED  Select only deprecated ISO-4217 codes. These codes are no longer in general public use. Draft: This API may be changed in the future versions and was introduced in ICU 3.2 UCURR_NON_DEPRECATED  Select only non-deprecated ISO-4217 codes. These codes are in general public use. Draft: This API may be changed in the future versions and was introduced in ICU 3.2 Definition at line 173 of file ucurr.h.

enum UCurrNameStyle

Selector constants for ucurr_getName(). See also: ucurr_getName Stable: ICU 2.6 Enumerator: UCURR_SYMBOL_NAME  Selector for ucurr_getName indicating a symbolic name for a currency, such as "$" for USD. Stable: ICU 2.6 UCURR_LONG_NAME  Selector for ucurr_getName indicating the long name for a currency, such as "US Dollar" for USD. Stable: ICU 2.6 Definition at line 64 of file ucurr.h.

---

Function Documentation

U_STABLE int32_t U_EXPORT2 ucurr_forLocale (  const char *  locale, UChar *  buff, int32_t  buffCapacity, UErrorCode *  ec )

Finds a currency code for the given locale. Parameters: locale  the locale for which to retrieve a currency code. Currency can be specified by the "currency" keyword in which case it overrides the default currency code buff  fill in buffer. Can be NULL for preflighting. buffCapacity  capacity of the fill in buffer. Can be 0 for preflighting. If it is non-zero, the buff parameter must not be NULL. ec  error code Returns: length of the currency string. It should always be 3. If 0, currency couldn't be found or the input values are invalid. Stable: ICU 2.8

U_DRAFT int32_t U_EXPORT2 ucurr_getDefaultFractionDigits (  const UChar *  currency, UErrorCode *  ec )

Returns the number of the number of fraction digits that should be displayed for the given currency. Parameters: currency  null-terminated 3-letter ISO 4217 code ec  input-output error code Returns: a non-negative number of fraction digits to be displayed, or 0 if there is an error Draft: This API may be changed in the future versions and was introduced in ICU 3.0

U_STABLE const UChar* U_EXPORT2 ucurr_getName (  const UChar *  currency, const char *  locale, UCurrNameStyle  nameStyle, UBool *  isChoiceFormat, int32_t *  len, UErrorCode *  ec )

Returns the display name for the given currency in the given locale. For example, the display name for the USD currency object in the en_US locale is "$". Parameters: currency  null-terminated 3-letter ISO 4217 code locale  locale in which to display currency nameStyle  selector for which kind of name to return isChoiceFormat  fill-in set to TRUE if the returned value is a ChoiceFormat pattern; otherwise it is a static string len  fill-in parameter to receive length of result ec  error code Returns: pointer to display string of 'len' UChars. If the resource data contains no entry for 'currency', then 'currency' itself is returned. If *isChoiceFormat is TRUE, then the result is a ChoiceFormat pattern. Otherwise it is a static string. Stable: ICU 2.6

U_DRAFT double U_EXPORT2 ucurr_getRoundingIncrement (  const UChar *  currency, UErrorCode *  ec )

Returns the rounding increment for the given currency, or 0.0 if no rounding is done by the currency. Parameters: currency  null-terminated 3-letter ISO 4217 code ec  input-output error code Returns: the non-negative rounding increment, or 0.0 if none, or 0.0 if there is an error Draft: This API may be changed in the future versions and was introduced in ICU 3.0

U_DRAFT UEnumeration* U_EXPORT2 ucurr_openISOCurrencies (  uint32_t  currType, UErrorCode *  pErrorCode )

Provides a UEnumeration object for listing ISO-4217 codes. Parameters: currType  You can use one of several UCurrCurrencyType values for this variable. You can also | (or) them together to get a specific list of currencies. Most people will want to use the (UCURR_CURRENCY|UCURR_NON_DEPRECATED) value to get a list of current currencies. pErrorCode  Error code Draft: This API may be changed in the future versions and was introduced in ICU 3.2

U_STABLE UCurrRegistryKey U_EXPORT2 ucurr_register (  const UChar *  isoCode, const char *  locale, UErrorCode *  status )

Register an (existing) ISO 4217 currency code for the given locale. Only the country code and the two variants EURO and PRE_EURO are recognized. Parameters: isoCode  the three-letter ISO 4217 currency code locale  the locale for which to register this currency code status  the in/out status code Returns: a registry key that can be used to unregister this currency code, or NULL if there was an error. Stable: ICU 2.6

U_STABLE UBool U_EXPORT2 ucurr_unregister (  UCurrRegistryKey  key, UErrorCode *  status )

Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_register. Key becomes invalid after a successful call and should not be used again. Any currency that might have been hidden by the original ucurr_register call is restored. Parameters: key  the registry key returned by a previous call to ucurr_register status  the in/out status code, no special meanings are assigned Returns: TRUE if the currency for this key was successfully unregistered Stable: ICU 2.6

---