ICU 69.1 69.1
ucurr.h
Go to the documentation of this file.
1// © 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
55#ifndef U_HIDE_DEPRECATED_API
61#endif // U_HIDE_DEPRECATED_API
62};
65
81U_CAPI int32_t U_EXPORT2
82ucurr_forLocale(const char* locale,
83 UChar* buff,
84 int32_t buffCapacity,
85 UErrorCode* ec);
86
93typedef enum UCurrNameStyle {
100
107
117
118#ifndef U_HIDE_DRAFT_API
128
137#endif // U_HIDE_DRAFT_API
138
140
141#if !UCONFIG_NO_SERVICE
145typedef const void* UCurrRegistryKey;
146
158U_CAPI UCurrRegistryKey U_EXPORT2
159ucurr_register(const UChar* isoCode,
160 const char* locale,
161 UErrorCode* status);
173U_CAPI UBool U_EXPORT2
175#endif /* UCONFIG_NO_SERVICE */
176
194U_CAPI const UChar* U_EXPORT2
195ucurr_getName(const UChar* currency,
196 const char* locale,
197 UCurrNameStyle nameStyle,
198 UBool* isChoiceFormat,
199 int32_t* len,
200 UErrorCode* ec);
201
219U_CAPI const UChar* U_EXPORT2
221 const char* locale,
222 UBool* isChoiceFormat,
223 const char* pluralCount,
224 int32_t* len,
225 UErrorCode* ec);
226
244U_CAPI int32_t U_EXPORT2
246 UErrorCode* ec);
247
265U_CAPI int32_t U_EXPORT2
267 const UCurrencyUsage usage,
268 UErrorCode* ec);
269
280U_CAPI double U_EXPORT2
282 UErrorCode* ec);
283
294U_CAPI double U_EXPORT2
296 const UCurrencyUsage usage,
297 UErrorCode* ec);
298
305typedef enum UCurrCurrencyType {
341
351U_CAPI UEnumeration * U_EXPORT2
352ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode);
353
380U_CAPI UBool U_EXPORT2
381ucurr_isAvailable(const UChar* isoCode,
382 UDate from,
383 UDate to,
384 UErrorCode* errorCode);
385
400U_CAPI int32_t U_EXPORT2
401ucurr_countCurrencies(const char* locale,
402 UDate date,
403 UErrorCode* ec);
404
424U_CAPI int32_t U_EXPORT2
425ucurr_forLocaleAndDate(const char* locale,
426 UDate date,
427 int32_t index,
428 UChar* buff,
429 int32_t buffCapacity,
430 UErrorCode* ec);
431
448U_CAPI UEnumeration* U_EXPORT2
450 const char* locale,
451 UBool commonlyUsed,
452 UErrorCode* status);
453
463U_CAPI int32_t U_EXPORT2
465
466#endif /* #if !UCONFIG_NO_FORMATTING */
467
468#endif
U_CAPI 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.
U_CAPI 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.
UCurrCurrencyType
Selector constants for ucurr_openCurrencies().
Definition: ucurr.h:305
@ UCURR_UNCOMMON
Select ISO-4217 uncommon currency codes.
Definition: ucurr.h:327
@ UCURR_NON_DEPRECATED
Select only non-deprecated ISO-4217 codes.
Definition: ucurr.h:339
@ UCURR_ALL
Select all ISO-4217 currency codes.
Definition: ucurr.h:310
@ UCURR_DEPRECATED
Select only deprecated ISO-4217 codes.
Definition: ucurr.h:333
@ UCURR_COMMON
Select only ISO-4217 commonly used currency codes.
Definition: ucurr.h:319
const void * UCurrRegistryKey
Definition: ucurr.h:145
U_CAPI UCurrRegistryKey ucurr_register(const UChar *isoCode, const char *locale, UErrorCode *status)
Register an (existing) ISO 4217 currency code for the given locale.
U_CAPI 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 ...
U_CAPI 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.
U_CAPI int32_t ucurr_getNumericCode(const UChar *currency)
Returns the ISO 4217 numeric code for the currency.
U_CAPI 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.
U_CAPI UEnumeration * ucurr_openISOCurrencies(uint32_t currType, UErrorCode *pErrorCode)
Provides a UEnumeration object for listing ISO-4217 codes.
U_CAPI 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...
U_CAPI 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...
UCurrNameStyle
Selector constants for ucurr_getName().
Definition: ucurr.h:93
@ UCURR_FORMAL_SYMBOL_NAME
Selector for getName() indicating the formal currency symbol.
Definition: ucurr.h:127
@ UCURR_VARIANT_SYMBOL_NAME
Selector for getName() indicating the variant currency symbol.
Definition: ucurr.h:136
@ UCURR_SYMBOL_NAME
Selector for ucurr_getName indicating a symbolic name for a currency, such as "$" for USD.
Definition: ucurr.h:99
@ UCURR_NARROW_SYMBOL_NAME
Selector for getName() indicating the narrow currency symbol.
Definition: ucurr.h:116
@ UCURR_LONG_NAME
Selector for ucurr_getName indicating the long name for a currency, such as "US Dollar" for USD.
Definition: ucurr.h:106
U_CAPI 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.
U_CAPI int32_t ucurr_forLocale(const char *locale, UChar *buff, int32_t buffCapacity, UErrorCode *ec)
Finds a currency code for the given locale.
U_CAPI int32_t ucurr_countCurrencies(const char *locale, UDate date, UErrorCode *ec)
Finds the number of valid currency codes for the given locale and date.
U_CAPI 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.
U_CAPI UBool ucurr_unregister(UCurrRegistryKey key, UErrorCode *status)
Unregister the previously-registered currency definitions using the URegistryKey returned from ucurr_...
UCurrencyUsage
Currency Usage used for Decimal Format.
Definition: ucurr.h:41
@ UCURR_USAGE_COUNT
One higher than the last enum UCurrencyUsage constant.
Definition: ucurr.h:60
@ UCURR_USAGE_STANDARD
a setting to specify currency usage which determines currency digit and rounding for standard usage,...
Definition: ucurr.h:48
@ UCURR_USAGE_CASH
a setting to specify currency usage which determines currency digit and rounding for cash usage,...
Definition: ucurr.h:54
C API: String Enumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:44
#define INT32_MAX
The largest value a 32 bit signed integer can hold.
Definition: umachine.h:208
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:418
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
double UDate
Date and Time data type.
Definition: utypes.h:203