ICU 56.1  56.1
ucurr.h
Go to the documentation of this file.
1 /*
2 **********************************************************************
3 * Copyright (c) 2002-2015, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
6 */
7 #ifndef _UCURR_H_
8 #define _UCURR_H_
9 
10 #include "unicode/utypes.h"
11 #include "unicode/uenum.h"
12 
18 #if !UCONFIG_NO_FORMATTING
19 
43 };
44 typedef enum UCurrencyUsage UCurrencyUsage;
45 
78 U_STABLE int32_t U_EXPORT2
79 ucurr_forLocale(const char* locale,
80  UChar* buff,
81  int32_t buffCapacity,
82  UErrorCode* ec);
83 
90 typedef enum UCurrNameStyle {
97 
105 
106 #if !UCONFIG_NO_SERVICE
107 
110 typedef const void* UCurrRegistryKey;
111 
123 U_STABLE UCurrRegistryKey U_EXPORT2
124 ucurr_register(const UChar* isoCode,
125  const char* locale,
126  UErrorCode* status);
138 U_STABLE UBool U_EXPORT2
140 #endif /* UCONFIG_NO_SERVICE */
141 
159 U_STABLE const UChar* U_EXPORT2
160 ucurr_getName(const UChar* currency,
161  const char* locale,
162  UCurrNameStyle nameStyle,
163  UBool* isChoiceFormat,
164  int32_t* len,
165  UErrorCode* ec);
166 
183 U_STABLE const UChar* U_EXPORT2
184 ucurr_getPluralName(const UChar* currency,
185  const char* locale,
186  UBool* isChoiceFormat,
187  const char* pluralCount,
188  int32_t* len,
189  UErrorCode* ec);
190 
201 U_STABLE int32_t U_EXPORT2
202 ucurr_getDefaultFractionDigits(const UChar* currency,
203  UErrorCode* ec);
204 
215 U_STABLE int32_t U_EXPORT2
217  const UCurrencyUsage usage,
218  UErrorCode* ec);
219 
230 U_STABLE double U_EXPORT2
231 ucurr_getRoundingIncrement(const UChar* currency,
232  UErrorCode* ec);
233 
244 U_STABLE double U_EXPORT2
246  const UCurrencyUsage usage,
247  UErrorCode* ec);
248 
255 typedef enum UCurrCurrencyType {
291 
301 U_STABLE UEnumeration * U_EXPORT2
302 ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode);
303 
330 U_STABLE UBool U_EXPORT2
331 ucurr_isAvailable(const UChar* isoCode,
332  UDate from,
333  UDate to,
334  UErrorCode* errorCode);
335 
350 U_STABLE int32_t U_EXPORT2
351 ucurr_countCurrencies(const char* locale,
352  UDate date,
353  UErrorCode* ec);
354 
374 U_STABLE int32_t U_EXPORT2
375 ucurr_forLocaleAndDate(const char* locale,
376  UDate date,
377  int32_t index,
378  UChar* buff,
379  int32_t buffCapacity,
380  UErrorCode* ec);
381 
398 U_STABLE UEnumeration* U_EXPORT2
399 ucurr_getKeywordValuesForLocale(const char* key,
400  const char* locale,
401  UBool commonlyUsed,
402  UErrorCode* status);
403 
413 U_STABLE int32_t U_EXPORT2
414 ucurr_getNumericCode(const UChar* currency);
415 
416 #endif /* #if !UCONFIG_NO_FORMATTING */
417 
418 #endif
UCurrRegistryKey ucurr_register(const UChar *isoCode, const char *locale, UErrorCode *status)
Register an (existing) ISO 4217 currency code for the given locale.
double ucurr_getRoundingIncrementForUsage(const UChar *currency, const UCurrencyUsage usage, UErrorCode *ec)
Returns the rounding increment for the given currency, or 0.0 if no rounding is done by the currency ...
Select all ISO-4217 currency codes.
Definition: ucurr.h:260
UCurrCurrencyType
Selector constants for ucurr_openCurrencies().
Definition: ucurr.h:255
int32_t ucurr_countCurrencies(const char *locale, UDate date, UErrorCode *ec)
Finds the number of valid currency codes for the given locale and date.
int32_t ucurr_forLocale(const char *locale, UChar *buff, int32_t buffCapacity, UErrorCode *ec)
The ucurr API encapsulates information about a currency, as defined by ISO 4217.
double UDate
Date and Time data type.
Definition: utypes.h:201
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:39
UBool ucurr_unregister(UCurrRegistryKey key, UErrorCode *status)
Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_...
int32_t ucurr_getNumericCode(const UChar *currency)
Returns the ISO 4217 numeric code for the 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...
int32_t ucurr_getDefaultFractionDigitsForUsage(const UChar *currency, const UCurrencyUsage usage, UErrorCode *ec)
Returns the number of the number of fraction digits that should be displayed for the given currency w...
int32_t ucurr_forLocaleAndDate(const char *locale, UDate date, int32_t index, UChar *buff, int32_t buffCapacity, UErrorCode *ec)
Finds a currency code for the given locale and date.
Select only ISO-4217 commonly used currency codes.
Definition: ucurr.h:269
UCurrencyUsage
Currency Usage used for Decimal Format.
Definition: ucurr.h:24
Selector for ucurr_getName indicating a symbolic name for a currency, such as "$" for USD...
Definition: ucurr.h:96
a setting to specify currency usage which determines currency digit and rounding for cash usage...
Definition: ucurr.h:37
const UChar * ucurr_getPluralName(const UChar *currency, const char *locale, UBool *isChoiceFormat, const char *pluralCount, int32_t *len, UErrorCode *ec)
Returns the plural name for the given currency in the given locale.
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
One higher than the last enum UCurrencyUsage constant.
Definition: ucurr.h:42
#define INT32_MAX
The largest value a 32 bit signed integer can hold.
Definition: umachine.h:180
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
UEnumeration * ucurr_getKeywordValuesForLocale(const char *key, const char *locale, UBool commonlyUsed, UErrorCode *status)
Given a key and a locale, returns an array of string values in a preferred order that would make a di...
Select only non-deprecated ISO-4217 codes.
Definition: ucurr.h:289
Select ISO-4217 uncommon currency codes.
Definition: ucurr.h:277
UEnumeration * ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode)
Provides a UEnumeration object for listing ISO-4217 codes.
C API: String Enumeration.
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.
Basic definitions for ICU, for both C and C++ APIs.
const void * UCurrRegistryKey
Definition: ucurr.h:110
UCurrNameStyle
Selector constants for ucurr_getName().
Definition: ucurr.h:90
Select only deprecated ISO-4217 codes.
Definition: ucurr.h:283
UBool ucurr_isAvailable(const UChar *isoCode, UDate from, UDate to, UErrorCode *errorCode)
Queries if the given ISO 4217 3-letter code is available on the specified date range.
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...
a setting to specify currency usage which determines currency digit and rounding for standard usage...
Definition: ucurr.h:31
Selector for ucurr_getName indicating the long name for a currency, such as "US Dollar" for USD...
Definition: ucurr.h:103
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234