#include "unicode/utypes.h"
#include "unicode/uenum.h"
Go to the source code of this file.
Typedefs | |
typedef const void * | UCurrRegistryKey |
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 | |
int32_t | ucurr_forLocale (const char *locale, UChar *buff, int32_t buffCapacity, UErrorCode *ec) |
Finds a currency code for the given locale. | |
UCurrRegistryKey | ucurr_register (const UChar *isoCode, const char *locale, UErrorCode *status) |
Register an (existing) ISO 4217 currency code for the given locale. | |
UBool | ucurr_unregister (UCurrRegistryKey key, UErrorCode *status) |
Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_register. | |
const UChar * | 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. | |
int32_t | ucurr_getDefaultFractionDigits (const UChar *currency, UErrorCode *ec) |
Returns the number of the number of fraction digits that should be displayed for the given currency. | |
double | 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. | |
UEnumeration * | ucurr_openISOCurrencies (uint32_t currType, UErrorCode *pErrorCode) |
Provides a UEnumeration object for listing ISO-4217 codes. |
Definition in file ucurr.h.
typedef const void* UCurrRegistryKey |
enum UCurrCurrencyType |
Selector constants for ucurr_openCurrencies().
UCURR_ALL |
Select all ISO-4217 currency codes.
|
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.
|
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.
|
UCURR_DEPRECATED |
Select only deprecated ISO-4217 codes.
These codes are no longer in general public use.
|
UCURR_NON_DEPRECATED |
Select only non-deprecated ISO-4217 codes.
These codes are in general public use.
|
enum UCurrNameStyle |
Selector constants for ucurr_getName().
int32_t ucurr_forLocale | ( | const char * | locale, | |
UChar * | buff, | |||
int32_t | buffCapacity, | |||
UErrorCode * | ec | |||
) |
Finds a currency code for the given locale.
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 |
int32_t ucurr_getDefaultFractionDigits | ( | const UChar * | currency, | |
UErrorCode * | ec | |||
) |
Returns the number of the number of fraction digits that should be displayed for the given currency.
currency | null-terminated 3-letter ISO 4217 code | |
ec | input-output error code |
const UChar* 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 "$".
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 |
double 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.
currency | null-terminated 3-letter ISO 4217 code | |
ec | input-output error code |
UEnumeration* ucurr_openISOCurrencies | ( | uint32_t | currType, | |
UErrorCode * | pErrorCode | |||
) |
Provides a UEnumeration object for listing ISO-4217 codes.
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 |
UCurrRegistryKey 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.
isoCode | the three-letter ISO 4217 currency code | |
locale | the locale for which to register this currency code | |
status | the in/out status code |
UBool 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.
key | the registry key returned by a previous call to ucurr_register | |
status | the in/out status code, no special meanings are assigned |