ICU 58.2 58.2

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

ucurr.h
Go to the documentation of this file.
1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 * Copyright (c) 2002-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
8 */
9 #ifndef _UCURR_H_
10 #define _UCURR_H_
11
12 #include "unicode/utypes.h"
13 #include "unicode/uenum.h"
14
35 #if !UCONFIG_NO_FORMATTING
36
41 enum UCurrencyUsage {
48 UCURR_USAGE_STANDARD=0,
54 UCURR_USAGE_CASH=1,
55 #ifndef U_HIDE_DEPRECATED_API
56
60 UCURR_USAGE_COUNT=2
61 #endif // U_HIDE_DEPRECATED_API
62 };
63 typedef enum UCurrencyUsage UCurrencyUsage;
64
80 U_STABLE int32_t U_EXPORT2
81 ucurr_forLocale(const char* locale,
82 UChar* buff,
83 int32_t buffCapacity,
84 UErrorCode* ec);
85
92 typedef enum UCurrNameStyle {
98 UCURR_SYMBOL_NAME,
99
105 UCURR_LONG_NAME
106 } UCurrNameStyle;
107
108 #if !UCONFIG_NO_SERVICE
109
112 typedef const void* UCurrRegistryKey;
113
125 U_STABLE UCurrRegistryKey U_EXPORT2
126 ucurr_register(const UChar* isoCode,
127 const char* locale,
128 UErrorCode* status);
140 U_STABLE UBool U_EXPORT2
141 ucurr_unregister(UCurrRegistryKey key, UErrorCode* status);
142 #endif /* UCONFIG_NO_SERVICE */
143
161 U_STABLE const UChar* U_EXPORT2
162 ucurr_getName(const UChar* currency,
163 const char* locale,
164 UCurrNameStyle nameStyle,
165 UBool* isChoiceFormat,
166 int32_t* len,
167 UErrorCode* ec);
168
185 U_STABLE const UChar* U_EXPORT2
186 ucurr_getPluralName(const UChar* currency,
187 const char* locale,
188 UBool* isChoiceFormat,
189 const char* pluralCount,
190 int32_t* len,
191 UErrorCode* ec);
192
203 U_STABLE int32_t U_EXPORT2
204 ucurr_getDefaultFractionDigits(const UChar* currency,
205 UErrorCode* ec);
206
217 U_STABLE int32_t U_EXPORT2
218 ucurr_getDefaultFractionDigitsForUsage(const UChar* currency,
219 const UCurrencyUsage usage,
220 UErrorCode* ec);
221
232 U_STABLE double U_EXPORT2
233 ucurr_getRoundingIncrement(const UChar* currency,
234 UErrorCode* ec);
235
246 U_STABLE double U_EXPORT2
247 ucurr_getRoundingIncrementForUsage(const UChar* currency,
248 const UCurrencyUsage usage,
249 UErrorCode* ec);
250
257 typedef enum UCurrCurrencyType {
262 UCURR_ALL = INT32_MAX,
271 UCURR_COMMON = 1,
279 UCURR_UNCOMMON = 2,
285 UCURR_DEPRECATED = 4,
291 UCURR_NON_DEPRECATED = 8
292 } UCurrCurrencyType;
293
303 U_STABLE UEnumeration * U_EXPORT2
304 ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode);
305
332 U_STABLE UBool U_EXPORT2
333 ucurr_isAvailable(const UChar* isoCode,
334 UDate from,
335 UDate to,
336 UErrorCode* errorCode);
337
352 U_STABLE int32_t U_EXPORT2
353 ucurr_countCurrencies(const char* locale,
354 UDate date,
355 UErrorCode* ec);
356
376 U_STABLE int32_t U_EXPORT2
377 ucurr_forLocaleAndDate(const char* locale,
378 UDate date,
379 int32_t index,
380 UChar* buff,
381 int32_t buffCapacity,
382 UErrorCode* ec);
383
400 U_STABLE UEnumeration* U_EXPORT2
401 ucurr_getKeywordValuesForLocale(const char* key,
402 const char* locale,
403 UBool commonlyUsed,
404 UErrorCode* status);
405
415 U_STABLE int32_t U_EXPORT2
416 ucurr_getNumericCode(const UChar* currency);
417
418 #endif /* #if !UCONFIG_NO_FORMATTING */
419
420 #endif
ucurr_register
UCurrRegistryKey ucurr_register(const UChar *isoCode, const char *locale, UErrorCode *status)
Register an (existing) ISO 4217 currency code for the given locale.
ucurr_getRoundingIncrementForUsage
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 ...
UCURR_ALL
Select all ISO-4217 currency codes.
Definition: ucurr.h:262
UCurrCurrencyType
UCurrCurrencyType
Selector constants for ucurr_openCurrencies().
Definition: ucurr.h:257
ucurr_countCurrencies
int32_t ucurr_countCurrencies(const char *locale, UDate date, UErrorCode *ec)
Finds the number of valid currency codes for the given locale and date.
ucurr_forLocale
int32_t ucurr_forLocale(const char *locale, UChar *buff, int32_t buffCapacity, UErrorCode *ec)
Finds a currency code for the given locale.
UDate
double UDate
Date and Time data type.
Definition: utypes.h:203
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:41
ucurr_unregister
UBool ucurr_unregister(UCurrRegistryKey key, UErrorCode *status)
Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_...
ucurr_getNumericCode
int32_t ucurr_getNumericCode(const UChar *currency)
Returns the ISO 4217 numeric code for the currency.
ucurr_getRoundingIncrement
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...
ucurr_getDefaultFractionDigitsForUsage
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...
ucurr_forLocaleAndDate
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.
UCURR_COMMON
Select only ISO-4217 commonly used currency codes.
Definition: ucurr.h:271
UCurrencyUsage
UCurrencyUsage
Currency Usage used for Decimal Format.
Definition: ucurr.h:41
UCURR_SYMBOL_NAME
Selector for ucurr_getName indicating a symbolic name for a currency, such as "$" for USD...
Definition: ucurr.h:98
UCURR_USAGE_CASH
a setting to specify currency usage which determines currency digit and rounding for cash usage...
Definition: ucurr.h:54
ucurr_getPluralName
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.
UChar
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:337
UCURR_USAGE_COUNT
One higher than the last enum UCurrencyUsage constant.
Definition: ucurr.h:60
INT32_MAX
#define INT32_MAX
The largest value a 32 bit signed integer can hold.
Definition: umachine.h:205
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
ucurr_getKeywordValuesForLocale
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...
UCURR_NON_DEPRECATED
Select only non-deprecated ISO-4217 codes.
Definition: ucurr.h:291
UCURR_UNCOMMON
Select ISO-4217 uncommon currency codes.
Definition: ucurr.h:279
ucurr_openISOCurrencies
UEnumeration * ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode)
Provides a UEnumeration object for listing ISO-4217 codes.
uenum.h
C API: String Enumeration.
ucurr_getName
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.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UCurrRegistryKey
const void * UCurrRegistryKey
Definition: ucurr.h:112
UCurrNameStyle
UCurrNameStyle
Selector constants for ucurr_getName().
Definition: ucurr.h:92
UCURR_DEPRECATED
Select only deprecated ISO-4217 codes.
Definition: ucurr.h:285
ucurr_isAvailable
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.
ucurr_getDefaultFractionDigits
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...
UCURR_USAGE_STANDARD
a setting to specify currency usage which determines currency digit and rounding for standard usage...
Definition: ucurr.h:48
UCURR_LONG_NAME
Selector for ucurr_getName indicating the long name for a currency, such as "US Dollar" for USD...
Definition: ucurr.h:105
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:134
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:259