C API: NumberFormat. More...

#include "unicode/utypes.h"
#include "unicode/localpointer.h"
#include "unicode/uloc.h"
#include "unicode/umisc.h"
#include "unicode/parseerr.h"
#include "unicode/uformattable.h"

Enumerations
enum	UNumberFormatStyle { UNUM_PATTERN_DECIMAL =0, UNUM_DECIMAL =1, UNUM_CURRENCY, UNUM_PERCENT, UNUM_SCIENTIFIC, UNUM_SPELLOUT, UNUM_ORDINAL, UNUM_DURATION, UNUM_NUMBERING_SYSTEM, UNUM_PATTERN_RULEBASED, UNUM_CURRENCY_ISO, UNUM_CURRENCY_PLURAL, UNUM_FORMAT_STYLE_COUNT, UNUM_DEFAULT = UNUM_DECIMAL, UNUM_IGNORE = UNUM_PATTERN_DECIMAL }

enum	UNumberFormatRoundingMode { UNUM_ROUND_CEILING, UNUM_ROUND_FLOOR, UNUM_ROUND_DOWN, UNUM_ROUND_UP, UNUM_ROUND_HALFEVEN, UNUM_FOUND_HALFEVEN = UNUM_ROUND_HALFEVEN, UNUM_ROUND_HALFDOWN = UNUM_ROUND_HALFEVEN + 1, UNUM_ROUND_HALFUP, UNUM_ROUND_UNNECESSARY }

enum	UNumberFormatPadPosition { UNUM_PAD_BEFORE_PREFIX, UNUM_PAD_AFTER_PREFIX, UNUM_PAD_BEFORE_SUFFIX, UNUM_PAD_AFTER_SUFFIX }

enum	UNumberCompactStyle { UNUM_SHORT, UNUM_LONG }

enum	UCurrencySpacing { UNUM_CURRENCY_MATCH, UNUM_CURRENCY_SURROUNDING_MATCH, UNUM_CURRENCY_INSERT, UNUM_CURRENCY_SPACING_COUNT }

enum	UNumberFormatFields { UNUM_INTEGER_FIELD, UNUM_FRACTION_FIELD, UNUM_DECIMAL_SEPARATOR_FIELD, UNUM_EXPONENT_SYMBOL_FIELD, UNUM_EXPONENT_SIGN_FIELD, UNUM_EXPONENT_FIELD, UNUM_GROUPING_SEPARATOR_FIELD, UNUM_CURRENCY_FIELD, UNUM_PERCENT_FIELD, UNUM_PERMILL_FIELD, UNUM_SIGN_FIELD, UNUM_FIELD_COUNT }

enum	UNumberFormatAttribute { UNUM_PARSE_INT_ONLY, UNUM_GROUPING_USED, UNUM_DECIMAL_ALWAYS_SHOWN, UNUM_MAX_INTEGER_DIGITS, UNUM_MIN_INTEGER_DIGITS, UNUM_INTEGER_DIGITS, UNUM_MAX_FRACTION_DIGITS, UNUM_MIN_FRACTION_DIGITS, UNUM_FRACTION_DIGITS, UNUM_MULTIPLIER, UNUM_GROUPING_SIZE, UNUM_ROUNDING_MODE, UNUM_ROUNDING_INCREMENT, UNUM_FORMAT_WIDTH, UNUM_PADDING_POSITION, UNUM_SECONDARY_GROUPING_SIZE, UNUM_SIGNIFICANT_DIGITS_USED, UNUM_MIN_SIGNIFICANT_DIGITS, UNUM_MAX_SIGNIFICANT_DIGITS, UNUM_LENIENT_PARSE, UNUM_SCALE = UNUM_LENIENT_PARSE + 2, UNUM_NUMERIC_ATTRIBUTE_COUNT = UNUM_LENIENT_PARSE + 3, UNUM_MAX_NONBOOLEAN_ATTRIBUTE = 0x0FFF, UNUM_FORMAT_FAIL_IF_MORE_THAN_MAX_DIGITS = 0x1000, UNUM_PARSE_NO_EXPONENT, UNUM_LIMIT_BOOLEAN_ATTRIBUTE }

enum	UNumberFormatTextAttribute { UNUM_POSITIVE_PREFIX, UNUM_POSITIVE_SUFFIX, UNUM_NEGATIVE_PREFIX, UNUM_NEGATIVE_SUFFIX, UNUM_PADDING_CHARACTER, UNUM_CURRENCY_CODE, UNUM_DEFAULT_RULESET, UNUM_PUBLIC_RULESETS }

enum	UNumberFormatSymbol { UNUM_DECIMAL_SEPARATOR_SYMBOL = 0, UNUM_GROUPING_SEPARATOR_SYMBOL = 1, UNUM_PATTERN_SEPARATOR_SYMBOL = 2, UNUM_PERCENT_SYMBOL = 3, UNUM_ZERO_DIGIT_SYMBOL = 4, UNUM_DIGIT_SYMBOL = 5, UNUM_MINUS_SIGN_SYMBOL = 6, UNUM_PLUS_SIGN_SYMBOL = 7, UNUM_CURRENCY_SYMBOL = 8, UNUM_INTL_CURRENCY_SYMBOL = 9, UNUM_MONETARY_SEPARATOR_SYMBOL = 10, UNUM_EXPONENTIAL_SYMBOL = 11, UNUM_PERMILL_SYMBOL = 12, UNUM_PAD_ESCAPE_SYMBOL = 13, UNUM_INFINITY_SYMBOL = 14, UNUM_NAN_SYMBOL = 15, UNUM_SIGNIFICANT_DIGIT_SYMBOL = 16, UNUM_MONETARY_GROUPING_SEPARATOR_SYMBOL = 17, UNUM_ONE_DIGIT_SYMBOL = 18, UNUM_TWO_DIGIT_SYMBOL = 19, UNUM_THREE_DIGIT_SYMBOL = 20, UNUM_FOUR_DIGIT_SYMBOL = 21, UNUM_FIVE_DIGIT_SYMBOL = 22, UNUM_SIX_DIGIT_SYMBOL = 23, UNUM_SEVEN_DIGIT_SYMBOL = 24, UNUM_EIGHT_DIGIT_SYMBOL = 25, UNUM_NINE_DIGIT_SYMBOL = 26, UNUM_FORMAT_SYMBOL_COUNT = 27 }

Functions
U_STABLE UNumberFormat *U_EXPORT2	unum_open (UNumberFormatStyle style, const UChar pattern, int32_t patternLength, const char locale, UParseError parseErr, UErrorCode status)

U_STABLE void U_EXPORT2	unum_close (UNumberFormat *fmt)

U_STABLE UNumberFormat *U_EXPORT2	unum_clone (const UNumberFormat fmt, UErrorCode status)

U_STABLE int32_t U_EXPORT2	unum_format (const UNumberFormat fmt, int32_t number, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode status)

U_STABLE int32_t U_EXPORT2	unum_formatInt64 (const UNumberFormat fmt, int64_t number, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode status)

U_STABLE int32_t U_EXPORT2	unum_formatDouble (const UNumberFormat fmt, double number, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode status)

U_STABLE int32_t U_EXPORT2	unum_formatDecimal (const UNumberFormat fmt, const char number, int32_t length, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode *status)

U_STABLE int32_t U_EXPORT2	unum_formatDoubleCurrency (const UNumberFormat fmt, double number, UChar currency, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode *status)

U_DRAFT int32_t U_EXPORT2	unum_formatUFormattable (const UNumberFormat fmt, const UFormattable number, UChar result, int32_t resultLength, UFieldPosition pos, UErrorCode *status)

U_STABLE int32_t U_EXPORT2	unum_parse (const UNumberFormat fmt, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode status)

U_STABLE int64_t U_EXPORT2	unum_parseInt64 (const UNumberFormat fmt, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode status)

U_STABLE double U_EXPORT2	unum_parseDouble (const UNumberFormat fmt, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode status)

U_STABLE int32_t U_EXPORT2	unum_parseDecimal (const UNumberFormat fmt, const UChar text, int32_t textLength, int32_t parsePos, char outBuf, int32_t outBufLength, UErrorCode *status)

U_STABLE double U_EXPORT2	unum_parseDoubleCurrency (const UNumberFormat fmt, const UChar text, int32_t textLength, int32_t parsePos, UChar currency, UErrorCode *status)

U_DRAFT UFormattable *U_EXPORT2	unum_parseToUFormattable (const UNumberFormat fmt, UFormattable result, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode *status)

U_STABLE void U_EXPORT2	unum_applyPattern (UNumberFormat format, UBool localized, const UChar pattern, int32_t patternLength, UParseError parseError, UErrorCode status)

U_STABLE const char *U_EXPORT2	unum_getAvailable (int32_t localeIndex)

U_STABLE int32_t U_EXPORT2	unum_countAvailable (void)

U_STABLE int32_t U_EXPORT2	unum_getAttribute (const UNumberFormat *fmt, UNumberFormatAttribute attr)

U_STABLE void U_EXPORT2	unum_setAttribute (UNumberFormat *fmt, UNumberFormatAttribute attr, int32_t newValue)

U_STABLE double U_EXPORT2	unum_getDoubleAttribute (const UNumberFormat *fmt, UNumberFormatAttribute attr)

U_STABLE void U_EXPORT2	unum_setDoubleAttribute (UNumberFormat *fmt, UNumberFormatAttribute attr, double newValue)

U_STABLE int32_t U_EXPORT2	unum_getTextAttribute (const UNumberFormat fmt, UNumberFormatTextAttribute tag, UChar result, int32_t resultLength, UErrorCode *status)

U_STABLE void U_EXPORT2	unum_setTextAttribute (UNumberFormat fmt, UNumberFormatTextAttribute tag, const UChar newValue, int32_t newValueLength, UErrorCode *status)

U_STABLE int32_t U_EXPORT2	unum_toPattern (const UNumberFormat fmt, UBool isPatternLocalized, UChar result, int32_t resultLength, UErrorCode *status)

U_STABLE int32_t U_EXPORT2	unum_getSymbol (const UNumberFormat fmt, UNumberFormatSymbol symbol, UChar buffer, int32_t size, UErrorCode *status)

U_STABLE void U_EXPORT2	unum_setSymbol (UNumberFormat fmt, UNumberFormatSymbol symbol, const UChar value, int32_t length, UErrorCode *status)

U_STABLE const char *U_EXPORT2	unum_getLocaleByType (const UNumberFormat fmt, ULocDataLocaleType type, UErrorCode status)

Detailed Description

C API: NumberFormat.

Number Format C API

Number Format C API Provides functions for formatting and parsing a number. Also provides methods for determining which locales have number formats, and what their names are.

UNumberFormat helps you to format and parse numbers for any locale. Your code can be completely independent of the locale conventions for decimal points, thousands-separators, or even the particular decimal digits used, or whether the number format is even decimal. There are different number format styles like decimal, currency, percent and spellout.

To format a number for the current Locale, use one of the static factory methods:

UChar myString[20];
double myNumber = 7.0;
UErrorCode status = U_ZERO_ERROR;
UNumberFormat* nf = unum_open(UNUM_DEFAULT, NULL, -1, NULL, NULL, &status);
unum_formatDouble(nf, myNumber, myString, 20, NULL, &status);
printf(" Example 1: %s\n", austrdup(myString) ); //austrdup( a function used to convert UChar* to char*)

If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.

uint32_t i, resultlength, reslenneeded;
UErrorCode status = U_ZERO_ERROR;
UFieldPosition pos;
uint32_t a[] = { 123, 3333, -1234567 };
const uint32_t a_len = sizeof(a) / sizeof(a[0]);
UNumberFormat* nf;
UChar* result = NULL;
nf = unum_open(UNUM_DEFAULT, NULL, -1, NULL, NULL, &status);
for (i = 0; i < a_len; i++) {
   resultlength=0;
   reslenneeded=unum_format(nf, a[i], NULL, resultlength, &pos, &status);
   result = NULL;
   if(status==U_BUFFER_OVERFLOW_ERROR){
      status=U_ZERO_ERROR;
      resultlength=reslenneeded+1;
      result=(UChar*)malloc(sizeof(UChar) * resultlength);
      unum_format(nf, a[i], result, resultlength, &pos, &status);
   }
   printf( " Example 2: %s\n", austrdup(result));
   free(result);
}

To format a number for a different Locale, specify it in the call to unum_open().

UNumberFormat* nf = unum_open(UNUM_DEFAULT, NULL, -1, "fr_FR", NULL, &success)

You can use a NumberFormat API unum_parse() to parse.

UErrorCode status = U_ZERO_ERROR;
int32_t pos=0;
int32_t num;
num = unum_parse(nf, str, u_strlen(str), &pos, &status);

Use UNUM_DECIMAL to get the normal number format for that country. There are other static options available. Use UNUM_CURRENCY to get the currency number format for that country. Use UNUM_PERCENT to get a format for displaying percentages. With this format, a fraction from 0.53 is displayed as 53%.

Use a pattern to create either a DecimalFormat or a RuleBasedNumberFormat formatter. The pattern must conform to the syntax defined for those formatters.

You can also control the display of numbers with such function as unum_getAttributes() and unum_setAttributes(), which let you set the miminum fraction digits, grouping, etc.

See also: UNumberFormatAttributes for more details

You can also use forms of the parse and format methods with ParsePosition and UFieldPosition to allow you to:

(a) progressively parse through pieces of a string.
(b) align the decimal point and other areas.

It is also possible to change or set the symbols used for a particular locale like the currency symbol, the grouping seperator , monetary seperator etc by making use of functions unum_setSymbols() and unum_getSymbols().

Typedef Documentation

◆ UCurrencySpacing

typedef enum UCurrencySpacing UCurrencySpacing

ICU 4.8

◆ UNumberCompactStyle

typedef enum UNumberCompactStyle UNumberCompactStyle

Constants for specifying short or long format. ICU 51

◆ UNumberFormat

typedef void* UNumberFormat

A number formatter. For usage in C programs. ICU 2.0

◆ UNumberFormatAttribute

typedef enum UNumberFormatAttribute UNumberFormatAttribute

The possible UNumberFormat numeric attributes ICU 2.0

◆ UNumberFormatFields

typedef enum UNumberFormatFields UNumberFormatFields

FieldPosition and UFieldPosition selectors for format fields defined by NumberFormat and UNumberFormat. ICU 49

◆ UNumberFormatPadPosition

typedef enum UNumberFormatPadPosition UNumberFormatPadPosition

The possible number format pad positions. ICU 2.0

◆ UNumberFormatRoundingMode

typedef enum UNumberFormatRoundingMode UNumberFormatRoundingMode

The possible number format rounding modes. ICU 2.0

◆ UNumberFormatStyle

typedef enum UNumberFormatStyle UNumberFormatStyle

The possible number format styles. ICU 2.0

◆ UNumberFormatSymbol

typedef enum UNumberFormatSymbol UNumberFormatSymbol

Constants for specifying a number format symbol. ICU 2.0

◆ UNumberFormatTextAttribute

typedef enum UNumberFormatTextAttribute UNumberFormatTextAttribute

The possible UNumberFormat text attributes ICU 2.0

Enumeration Type Documentation

◆ UCurrencySpacing

enum UCurrencySpacing

Constants for specifying currency spacing ICU 4.8

Enumerator
UNUM_CURRENCY_MATCH	ICU 4.8
UNUM_CURRENCY_SURROUNDING_MATCH	ICU 4.8
UNUM_CURRENCY_INSERT	ICU 4.8
UNUM_CURRENCY_SPACING_COUNT	ICU 4.8

◆ UNumberCompactStyle

enum UNumberCompactStyle

Constants for specifying short or long format. ICU 51

Enumerator
UNUM_SHORT	ICU 51
UNUM_LONG	ICU 51 ICU 51

◆ UNumberFormatAttribute

enum UNumberFormatAttribute

The possible UNumberFormat numeric attributes ICU 2.0

Enumerator
UNUM_PARSE_INT_ONLY	Parse integers only
UNUM_GROUPING_USED	Use grouping separator
UNUM_DECIMAL_ALWAYS_SHOWN	Always show decimal point
UNUM_MAX_INTEGER_DIGITS	Maximum integer digits
UNUM_MIN_INTEGER_DIGITS	Minimum integer digits
UNUM_INTEGER_DIGITS	Integer digits
UNUM_MAX_FRACTION_DIGITS	Maximum fraction digits
UNUM_MIN_FRACTION_DIGITS	Minimum fraction digits
UNUM_FRACTION_DIGITS	Fraction digits
UNUM_MULTIPLIER	Multiplier
UNUM_GROUPING_SIZE	Grouping size
UNUM_ROUNDING_MODE	Rounding Mode
UNUM_ROUNDING_INCREMENT	Rounding increment
UNUM_FORMAT_WIDTH	The width to which the output of `format()` is padded.
UNUM_PADDING_POSITION	The position at which padding will take place.
UNUM_SECONDARY_GROUPING_SIZE	Secondary grouping size
UNUM_SIGNIFICANT_DIGITS_USED	Use significant digits ICU 3.0
UNUM_MIN_SIGNIFICANT_DIGITS	Minimum significant digits ICU 3.0
UNUM_MAX_SIGNIFICANT_DIGITS	Maximum significant digits ICU 3.0
UNUM_LENIENT_PARSE	Lenient parse mode used by rule-based formats. ICU 3.0
UNUM_SCALE	Scale, which adjusts the position of the decimal point when formatting. Amounts will be multiplied by 10 ^ (scale) before they are formatted. The default value for the scale is 0 ( no adjustment ). Example: setting the scale to 3, 123 formats as "123,000" Example: setting the scale to -4, 123 formats as "0.0123" ICU 51
UNUM_NUMERIC_ATTRIBUTE_COUNT	Count of "regular" numeric attributes.
UNUM_MAX_NONBOOLEAN_ATTRIBUTE	One below the first bitfield-boolean item. All items after this one are stored in boolean form.
UNUM_FORMAT_FAIL_IF_MORE_THAN_MAX_DIGITS	If 1, specifies that if setting the "max integer digits" attribute would truncate a value, set an error status rather than silently truncating. For example, formatting the value 1234 with 4 max int digits would succeed, but formatting 12345 would fail. There is no effect on parsing. Default: 0 (not set) ICU 50
UNUM_PARSE_NO_EXPONENT	if this attribute is set to 1, specifies that, if the pattern doesn't contain an exponent, the exponent will not be parsed. If the pattern does contain an exponent, this attribute has no effect. Has no effect on formatting. Default: 0 (unset) ICU 50
UNUM_LIMIT_BOOLEAN_ATTRIBUTE	Limit of boolean attributes.

◆ UNumberFormatFields

enum UNumberFormatFields

FieldPosition and UFieldPosition selectors for format fields defined by NumberFormat and UNumberFormat. ICU 49

Enumerator
UNUM_INTEGER_FIELD	ICU 49
UNUM_FRACTION_FIELD	ICU 49
UNUM_DECIMAL_SEPARATOR_FIELD	ICU 49
UNUM_EXPONENT_SYMBOL_FIELD	ICU 49
UNUM_EXPONENT_SIGN_FIELD	ICU 49
UNUM_EXPONENT_FIELD	ICU 49
UNUM_GROUPING_SEPARATOR_FIELD	ICU 49
UNUM_CURRENCY_FIELD	ICU 49
UNUM_PERCENT_FIELD	ICU 49
UNUM_PERMILL_FIELD	ICU 49
UNUM_SIGN_FIELD	ICU 49
UNUM_FIELD_COUNT	ICU 49

◆ UNumberFormatPadPosition

enum UNumberFormatPadPosition

The possible number format pad positions. ICU 2.0

Enumerator
UNUM_PAD_BEFORE_PREFIX
UNUM_PAD_AFTER_PREFIX
UNUM_PAD_BEFORE_SUFFIX
UNUM_PAD_AFTER_SUFFIX

◆ UNumberFormatRoundingMode

enum UNumberFormatRoundingMode

The possible number format rounding modes. ICU 2.0

Enumerator
UNUM_ROUND_CEILING
UNUM_ROUND_FLOOR
UNUM_ROUND_DOWN
UNUM_ROUND_UP
UNUM_ROUND_HALFEVEN	Half-even rounding , ICU 3.8
UNUM_FOUND_HALFEVEN	Half-even rounding, misspelled name Deprecated: , ICU 3.8
UNUM_ROUND_HALFDOWN
UNUM_ROUND_HALFUP
UNUM_ROUND_UNNECESSARY	ROUND_UNNECESSARY reports an error if formatted result is not exact. ICU 4.8

◆ UNumberFormatStyle

enum UNumberFormatStyle

The possible number format styles. ICU 2.0

Enumerator
UNUM_PATTERN_DECIMAL	Decimal format defined by a pattern string. ICU 3.0
UNUM_DECIMAL	Decimal format ("normal" style). ICU 2.0
UNUM_CURRENCY	Currency format with a currency symbol, e.g., "$1.00". ICU 2.0
UNUM_PERCENT	Percent format ICU 2.0
UNUM_SCIENTIFIC	Scientific format ICU 2.1
UNUM_SPELLOUT	Spellout rule-based format ICU 2.0
UNUM_ORDINAL	Ordinal rule-based format ICU 3.0
UNUM_DURATION	Duration rule-based format ICU 3.0
UNUM_NUMBERING_SYSTEM	Numbering system rule-based format ICU 4.2
UNUM_PATTERN_RULEBASED	Rule-based format defined by a pattern string. ICU 3.0
UNUM_CURRENCY_ISO	Currency format with an ISO currency code, e.g., "USD1.00". ICU 4.8
UNUM_CURRENCY_PLURAL	Currency format with a pluralized currency name, e.g., "1.00 US dollar" and "3.00 US dollars". ICU 4.8
UNUM_FORMAT_STYLE_COUNT	One more than the highest number format style constant. ICU 4.8
UNUM_DEFAULT	Default format ICU 2.0
UNUM_IGNORE	Alias for UNUM_PATTERN_DECIMAL ICU 3.0

◆ UNumberFormatSymbol

enum UNumberFormatSymbol

Constants for specifying a number format symbol. ICU 2.0

Enumerator
UNUM_DECIMAL_SEPARATOR_SYMBOL	The decimal separator
UNUM_GROUPING_SEPARATOR_SYMBOL	The grouping separator
UNUM_PATTERN_SEPARATOR_SYMBOL	The pattern separator
UNUM_PERCENT_SYMBOL	The percent sign
UNUM_ZERO_DIGIT_SYMBOL	Zero
UNUM_DIGIT_SYMBOL	Character representing a digit in the pattern
UNUM_MINUS_SIGN_SYMBOL	The minus sign
UNUM_PLUS_SIGN_SYMBOL	The plus sign
UNUM_CURRENCY_SYMBOL	The currency symbol
UNUM_INTL_CURRENCY_SYMBOL	The international currency symbol
UNUM_MONETARY_SEPARATOR_SYMBOL	The monetary separator
UNUM_EXPONENTIAL_SYMBOL	The exponential symbol
UNUM_PERMILL_SYMBOL	Per mill symbol
UNUM_PAD_ESCAPE_SYMBOL	Escape padding character
UNUM_INFINITY_SYMBOL	Infinity symbol
UNUM_NAN_SYMBOL	Nan symbol
UNUM_SIGNIFICANT_DIGIT_SYMBOL	Significant digit symbol ICU 3.0
UNUM_MONETARY_GROUPING_SEPARATOR_SYMBOL	The monetary grouping separator ICU 3.6
UNUM_ONE_DIGIT_SYMBOL	One ICU 4.6
UNUM_TWO_DIGIT_SYMBOL	Two ICU 4.6
UNUM_THREE_DIGIT_SYMBOL	Three ICU 4.6
UNUM_FOUR_DIGIT_SYMBOL	Four ICU 4.6
UNUM_FIVE_DIGIT_SYMBOL	Five ICU 4.6
UNUM_SIX_DIGIT_SYMBOL	Six ICU 4.6
UNUM_SEVEN_DIGIT_SYMBOL	Seven ICU 4.6
UNUM_EIGHT_DIGIT_SYMBOL	Eight ICU 4.6
UNUM_NINE_DIGIT_SYMBOL	Nine ICU 4.6
UNUM_FORMAT_SYMBOL_COUNT	count symbol constants

◆ UNumberFormatTextAttribute

enum UNumberFormatTextAttribute

The possible UNumberFormat text attributes ICU 2.0

Enumerator
UNUM_POSITIVE_PREFIX	Positive prefix
UNUM_POSITIVE_SUFFIX	Positive suffix
UNUM_NEGATIVE_PREFIX	Negative prefix
UNUM_NEGATIVE_SUFFIX	Negative suffix
UNUM_PADDING_CHARACTER	The character used to pad to the format width.
UNUM_CURRENCY_CODE	The ISO currency code
UNUM_DEFAULT_RULESET	The default rule set. This is only available with rule-based formatters. ICU 3.0
UNUM_PUBLIC_RULESETS	The public rule sets. This is only available with rule-based formatters. This is a read-only attribute. The public rulesets are returned as a single string, with each ruleset name delimited by ';' (semicolon). ICU 3.0

Function Documentation

◆ unum_applyPattern()

U_STABLE void U_EXPORT2 unum_applyPattern	(	UNumberFormat *	format,
		UBool	localized,
		const UChar *	pattern,
		int32_t	patternLength,
		UParseError *	parseError,
		UErrorCode *	status
	)

Set the pattern used by a UNumberFormat. This can only be used on a DecimalFormat, other formats return U_UNSUPPORTED_ERROR in the status.

Parameters

format	The formatter to set.
localized	TRUE if the pattern is localized, FALSE otherwise.
pattern	The new pattern
patternLength	The length of pattern, or -1 if null-terminated.
parseError	A pointer to UParseError to recieve information about errors occurred during parsing, or NULL if no parse error information is desired.
status	A pointer to an input-output UErrorCode.

See also: unum_toPattern; DecimalFormat ICU 2.0

◆ unum_clone()

U_STABLE UNumberFormat* U_EXPORT2 unum_clone	(	const UNumberFormat *	fmt,
		UErrorCode *	status
	)

Open a copy of a UNumberFormat. This function performs a deep copy.

Parameters

fmt	The format to copy
status	A pointer to an UErrorCode to receive any errors.

Returns: A pointer to a UNumberFormat identical to fmt. ICU 2.0

◆ unum_close()

U_STABLE void U_EXPORT2 unum_close ( UNumberFormat * fmt )

Close a UNumberFormat. Once closed, a UNumberFormat may no longer be used.

Parameters

fmt	The formatter to close. ICU 2.0

◆ unum_countAvailable()

U_STABLE int32_t U_EXPORT2 unum_countAvailable ( void )

Determine how many locales have decimal formatting patterns available. The results of this call are not valid for rule-based number formats. This function is useful for determining the loop ending condition for calls to unum_getAvailable.

Returns: The number of locales for which decimal formatting patterns are available.

See also: unum_getAvailable ICU 2.0

◆ unum_format()

U_STABLE int32_t U_EXPORT2 unum_format	(	const UNumberFormat *	fmt,
		int32_t	number,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format an integer using a UNumberFormat. The integer will be formatted according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
number	The number to format.
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	The maximum size of result.
pos	A pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case no field
status	A pointer to an UErrorCode to receive any errors

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_formatInt64; unum_formatDouble; unum_parse; unum_parseInt64; unum_parseDouble; UFieldPosition ICU 2.0

◆ unum_formatDecimal()

U_STABLE int32_t U_EXPORT2 unum_formatDecimal	(	const UNumberFormat *	fmt,
		const char *	number,
		int32_t	length,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format a decimal number using a UNumberFormat. The number will be formatted according to the UNumberFormat's locale. The syntax of the input number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal

Parameters

fmt	The formatter to use.
number	The number to format.
length	The length of the input number, or -1 if the input is nul-terminated.
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	The maximum size of result.
pos	A pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case it is ignored.
status	A pointer to an UErrorCode to receive any errors

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_format; unum_formatInt64; unum_parse; unum_parseInt64; unum_parseDouble; UFieldPosition ICU 4.4

◆ unum_formatDouble()

U_STABLE int32_t U_EXPORT2 unum_formatDouble	(	const UNumberFormat *	fmt,
		double	number,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format a double using a UNumberFormat. The double will be formatted according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
number	The number to format.
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	The maximum size of result.
pos	A pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case no field
status	A pointer to an UErrorCode to receive any errors

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_format; unum_formatInt64; unum_parse; unum_parseInt64; unum_parseDouble; UFieldPosition ICU 2.0

◆ unum_formatDoubleCurrency()

U_STABLE int32_t U_EXPORT2 unum_formatDoubleCurrency	(	const UNumberFormat *	fmt,
		double	number,
		UChar *	currency,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format a double currency amount using a UNumberFormat. The double will be formatted according to the UNumberFormat's locale.

Parameters

fmt	the formatter to use
number	the number to format
currency	the 3-letter null-terminated ISO 4217 currency code
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	the maximum number of UChars to write to result
pos	a pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case it is ignored.
status	a pointer to an input-output UErrorCode

Returns: the total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_formatDouble; unum_parseDoubleCurrency; UFieldPosition ICU 3.0

◆ unum_formatInt64()

U_STABLE int32_t U_EXPORT2 unum_formatInt64	(	const UNumberFormat *	fmt,
		int64_t	number,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format an int64 using a UNumberFormat. The int64 will be formatted according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
number	The number to format.
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	The maximum size of result.
pos	A pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case no field
status	A pointer to an UErrorCode to receive any errors

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_format; unum_formatDouble; unum_parse; unum_parseInt64; unum_parseDouble; UFieldPosition ICU 2.0

◆ unum_formatUFormattable()

U_DRAFT int32_t U_EXPORT2 unum_formatUFormattable	(	const UNumberFormat *	fmt,
		const UFormattable *	number,
		UChar *	result,
		int32_t	resultLength,
		UFieldPosition *	pos,
		UErrorCode *	status
	)

Format a UFormattable into a string.

Parameters

fmt	the formatter to use
number	the number to format, as a UFormattable
result	A pointer to a buffer to receive the NULL-terminated formatted number. If the formatted number fits into dest but cannot be NULL-terminated (length == resultLength) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the formatted number doesn't fit into result then the error code is set to U_BUFFER_OVERFLOW_ERROR.
resultLength	the maximum number of UChars to write to result
pos	a pointer to a UFieldPosition. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case it is ignored.
status	a pointer to an input-output UErrorCode

Returns: the total buffer size needed; if greater than resultLength, the output was truncated. Will return 0 on error.

See also: unum_parseToUFormattable ICU 52

◆ unum_getAttribute()

U_STABLE int32_t U_EXPORT2 unum_getAttribute	(	const UNumberFormat *	fmt,
		UNumberFormatAttribute	attr
	)

Get a numeric attribute associated with a UNumberFormat. An example of a numeric attribute is the number of integer digits a formatter will produce.

Parameters

fmt	The formatter to query.
attr	The attribute to query; one of UNUM_PARSE_INT_ONLY, UNUM_GROUPING_USED, UNUM_DECIMAL_ALWAYS_SHOWN, UNUM_MAX_INTEGER_DIGITS, UNUM_MIN_INTEGER_DIGITS, UNUM_INTEGER_DIGITS, UNUM_MAX_FRACTION_DIGITS, UNUM_MIN_FRACTION_DIGITS, UNUM_FRACTION_DIGITS, UNUM_MULTIPLIER, UNUM_GROUPING_SIZE, UNUM_ROUNDING_MODE, UNUM_FORMAT_WIDTH, UNUM_PADDING_POSITION, UNUM_SECONDARY_GROUPING_SIZE, UNUM_SCALE.

Returns: The value of attr.

See also: unum_setAttribute; unum_getDoubleAttribute; unum_setDoubleAttribute; unum_getTextAttribute; unum_setTextAttribute ICU 2.0

◆ unum_getAvailable()

U_STABLE const char* U_EXPORT2 unum_getAvailable ( int32_t localeIndex )

Get a locale for which decimal formatting patterns are available. A UNumberFormat in a locale returned by this function will perform the correct formatting and parsing for the locale. The results of this call are not valid for rule-based number formats.

Parameters

localeIndex The index of the desired locale.

Returns: A locale for which number formatting patterns are available, or 0 if none.

See also: unum_countAvailable ICU 2.0

◆ unum_getDoubleAttribute()

U_STABLE double U_EXPORT2 unum_getDoubleAttribute	(	const UNumberFormat *	fmt,
		UNumberFormatAttribute	attr
	)

Get a numeric attribute associated with a UNumberFormat. An example of a numeric attribute is the number of integer digits a formatter will produce. If the formatter does not understand the attribute, -1 is returned.

Parameters

fmt	The formatter to query.
attr	The attribute to query; e.g. UNUM_ROUNDING_INCREMENT.

Returns: The value of attr.

See also: unum_getAttribute; unum_setAttribute; unum_setDoubleAttribute; unum_getTextAttribute; unum_setTextAttribute ICU 2.0

◆ unum_getLocaleByType()

U_STABLE const char* U_EXPORT2 unum_getLocaleByType	(	const UNumberFormat *	fmt,
		ULocDataLocaleType	type,
		UErrorCode *	status
	)

Get the locale for this number format object. You can choose between valid and actual locale.

Parameters

fmt	The formatter to get the locale from
type	type of the locale we're looking for (valid or actual)
status	error code for the operation

Returns: the locale name ICU 2.8

◆ unum_getSymbol()

U_STABLE int32_t U_EXPORT2 unum_getSymbol	(	const UNumberFormat *	fmt,
		UNumberFormatSymbol	symbol,
		UChar *	buffer,
		int32_t	size,
		UErrorCode *	status
	)

Get a symbol associated with a UNumberFormat. A UNumberFormat uses symbols to represent the special locale-dependent characters in a number, for example the percent sign. This API is not supported for rule-based formatters.

Parameters

fmt	The formatter to query.
symbol	The UNumberFormatSymbol constant for the symbol to get
buffer	The string buffer that will receive the symbol string; if it is NULL, then only the length of the symbol is returned
size	The size of the string buffer
status	A pointer to an UErrorCode to receive any errors

Returns: The length of the symbol; the buffer is not modified if length>=size

See also: unum_setSymbol ICU 2.0

◆ unum_getTextAttribute()

U_STABLE int32_t U_EXPORT2 unum_getTextAttribute	(	const UNumberFormat *	fmt,
		UNumberFormatTextAttribute	tag,
		UChar *	result,
		int32_t	resultLength,
		UErrorCode *	status
	)

Get a text attribute associated with a UNumberFormat. An example of a text attribute is the suffix for positive numbers. If the formatter does not understand the attribute, U_UNSUPPORTED_ERROR is returned as the status. Rule-based formatters only understand UNUM_DEFAULT_RULESET and UNUM_PUBLIC_RULESETS.

Parameters

fmt	The formatter to query.
tag	The attribute to query; one of UNUM_POSITIVE_PREFIX, UNUM_POSITIVE_SUFFIX, UNUM_NEGATIVE_PREFIX, UNUM_NEGATIVE_SUFFIX, UNUM_PADDING_CHARACTER, UNUM_CURRENCY_CODE, UNUM_DEFAULT_RULESET, or UNUM_PUBLIC_RULESETS.
result	A pointer to a buffer to receive the attribute.
resultLength	The maximum size of result.
status	A pointer to an UErrorCode to receive any errors

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_setTextAttribute; unum_getAttribute; unum_setAttribute ICU 2.0

◆ unum_open()

U_STABLE UNumberFormat* U_EXPORT2 unum_open	(	UNumberFormatStyle	style,
		const UChar *	pattern,
		int32_t	patternLength,
		const char *	locale,
		UParseError *	parseErr,
		UErrorCode *	status
	)

Create and return a new UNumberFormat for formatting and parsing numbers. A UNumberFormat may be used to format numbers by calling unum_format, and to parse numbers by calling unum_parse. The caller must call unum_close when done to release resources used by this object.

Parameters

style	The type of number format to open: one of UNUM_DECIMAL, UNUM_CURRENCY, UNUM_PERCENT, UNUM_SCIENTIFIC, UNUM_SPELLOUT, UNUM_PATTERN_DECIMAL, UNUM_PATTERN_RULEBASED, or UNUM_DEFAULT. If UNUM_PATTERN_DECIMAL or UNUM_PATTERN_RULEBASED is passed then the number format is opened using the given pattern, which must conform to the syntax described in DecimalFormat or RuleBasedNumberFormat, respectively.
pattern	A pattern specifying the format to use. This parameter is ignored unless the style is UNUM_PATTERN_DECIMAL or UNUM_PATTERN_RULEBASED.
patternLength	The number of characters in the pattern, or -1 if null-terminated. This parameter is ignored unless the style is UNUM_PATTERN.
locale	A locale identifier to use to determine formatting and parsing conventions, or NULL to use the default locale.
parseErr	A pointer to a UParseError struct to receive the details of any parsing errors, or NULL if no parsing error details are desired.
status	A pointer to an input-output UErrorCode.

Returns: A pointer to a newly created UNumberFormat, or NULL if an error occurred.

See also: unum_close; DecimalFormat ICU 2.0

◆ unum_parse()

U_STABLE int32_t U_EXPORT2 unum_parse	(	const UNumberFormat *	fmt,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		UErrorCode *	status
	)

Parse a string into an integer using a UNumberFormat. The string will be parsed according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
text	The text to parse.
textLength	The length of text, or -1 if null-terminated.
parsePos	If not NULL, on input a pointer to an integer specifying the offset at which to begin parsing. If not NULL, on output the offset at which parsing ended.
status	A pointer to an UErrorCode to receive any errors

Returns: The value of the parsed integer

See also: unum_parseInt64; unum_parseDouble; unum_format; unum_formatInt64; unum_formatDouble ICU 2.0

◆ unum_parseDecimal()

U_STABLE int32_t U_EXPORT2 unum_parseDecimal	(	const UNumberFormat *	fmt,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		char *	outBuf,
		int32_t	outBufLength,
		UErrorCode *	status
	)

Parse a number from a string into an unformatted numeric string using a UNumberFormat. The input string will be parsed according to the UNumberFormat's locale. The syntax of the output is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal

Parameters

fmt	The formatter to use.
text	The text to parse.
textLength	The length of text, or -1 if null-terminated.
parsePos	If not NULL, on input a pointer to an integer specifying the offset at which to begin parsing. If not NULL, on output the offset at which parsing ended.
outBuf	A (char *) buffer to receive the parsed number as a string. The output string will be nul-terminated if there is sufficient space.
outBufLength	The size of the output buffer. May be zero, in which case the outBuf pointer may be NULL, and the function will return the size of the output string.
status	A pointer to an UErrorCode to receive any errors

Returns: the length of the output string, not including any terminating nul.

See also: unum_parse; unum_parseInt64; unum_format; unum_formatInt64; unum_formatDouble ICU 4.4

◆ unum_parseDouble()

U_STABLE double U_EXPORT2 unum_parseDouble	(	const UNumberFormat *	fmt,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		UErrorCode *	status
	)

Parse a string into a double using a UNumberFormat. The string will be parsed according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
text	The text to parse.
textLength	The length of text, or -1 if null-terminated.
parsePos	If not NULL, on input a pointer to an integer specifying the offset at which to begin parsing. If not NULL, on output the offset at which parsing ended.
status	A pointer to an UErrorCode to receive any errors

Returns: The value of the parsed double

See also: unum_parse; unum_parseInt64; unum_format; unum_formatInt64; unum_formatDouble ICU 2.0

◆ unum_parseDoubleCurrency()

U_STABLE double U_EXPORT2 unum_parseDoubleCurrency	(	const UNumberFormat *	fmt,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		UChar *	currency,
		UErrorCode *	status
	)

Parse a string into a double and a currency using a UNumberFormat. The string will be parsed according to the UNumberFormat's locale.

Parameters

fmt	the formatter to use
text	the text to parse
textLength	the length of text, or -1 if null-terminated
parsePos	a pointer to an offset index into text at which to begin parsing. On output, *parsePos will point after the last parsed character. This parameter may be NULL, in which case parsing begins at offset 0.
currency	a pointer to the buffer to receive the parsed null- terminated currency. This buffer must have a capacity of at least 4 UChars.
status	a pointer to an input-output UErrorCode

Returns: the parsed double

See also: unum_parseDouble; unum_formatDoubleCurrency ICU 3.0

◆ unum_parseInt64()

U_STABLE int64_t U_EXPORT2 unum_parseInt64	(	const UNumberFormat *	fmt,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		UErrorCode *	status
	)

Parse a string into an int64 using a UNumberFormat. The string will be parsed according to the UNumberFormat's locale.

Parameters

fmt	The formatter to use.
text	The text to parse.
textLength	The length of text, or -1 if null-terminated.
parsePos	If not NULL, on input a pointer to an integer specifying the offset at which to begin parsing. If not NULL, on output the offset at which parsing ended.
status	A pointer to an UErrorCode to receive any errors

Returns: The value of the parsed integer

See also: unum_parse; unum_parseDouble; unum_format; unum_formatInt64; unum_formatDouble ICU 2.8

◆ unum_parseToUFormattable()

U_DRAFT UFormattable* U_EXPORT2 unum_parseToUFormattable	(	const UNumberFormat *	fmt,
		UFormattable *	result,
		const UChar *	text,
		int32_t	textLength,
		int32_t *	parsePos,
		UErrorCode *	status
	)

Parse a UChar string into a UFormattable. Example code:

Parameters

fmt	the formatter to use
result	the UFormattable to hold the result. If NULL, a new UFormattable will be allocated (which the caller must close with ufmt_close).
text	the text to parse
textLength	the length of text, or -1 if null-terminated
parsePos	a pointer to an offset index into text at which to begin parsing. On output, *parsePos will point after the last parsed character. This parameter may be NULL in which case parsing begins at offset 0.
status	a pointer to an input-output UErrorCode

Returns: the UFormattable. Will be ==result unless NULL was passed in for result, in which case it will be the newly opened UFormattable.

See also: ufmt_getType; ufmt_close ICU 52

◆ unum_setAttribute()

U_STABLE void U_EXPORT2 unum_setAttribute	(	UNumberFormat *	fmt,
		UNumberFormatAttribute	attr,
		int32_t	newValue
	)

Set a numeric attribute associated with a UNumberFormat. An example of a numeric attribute is the number of integer digits a formatter will produce. If the formatter does not understand the attribute, the call is ignored. Rule-based formatters only understand the lenient-parse attribute.

Parameters

fmt	The formatter to set.
attr	The attribute to set; one of UNUM_PARSE_INT_ONLY, UNUM_GROUPING_USED, UNUM_DECIMAL_ALWAYS_SHOWN, UNUM_MAX_INTEGER_DIGITS, UNUM_MIN_INTEGER_DIGITS, UNUM_INTEGER_DIGITS, UNUM_MAX_FRACTION_DIGITS, UNUM_MIN_FRACTION_DIGITS, UNUM_FRACTION_DIGITS, UNUM_MULTIPLIER, UNUM_GROUPING_SIZE, UNUM_ROUNDING_MODE, UNUM_FORMAT_WIDTH, UNUM_PADDING_POSITION, UNUM_SECONDARY_GROUPING_SIZE, UNUM_LENIENT_PARSE, or UNUM_SCALE.
newValue	The new value of attr.

See also: unum_getAttribute; unum_getDoubleAttribute; unum_setDoubleAttribute; unum_getTextAttribute; unum_setTextAttribute ICU 2.0

◆ unum_setDoubleAttribute()

U_STABLE void U_EXPORT2 unum_setDoubleAttribute	(	UNumberFormat *	fmt,
		UNumberFormatAttribute	attr,
		double	newValue
	)

Set a numeric attribute associated with a UNumberFormat. An example of a numeric attribute is the number of integer digits a formatter will produce. If the formatter does not understand the attribute, this call is ignored.

Parameters

fmt	The formatter to set.
attr	The attribute to set; e.g. UNUM_ROUNDING_INCREMENT.
newValue	The new value of attr.

See also: unum_getAttribute; unum_setAttribute; unum_getDoubleAttribute; unum_getTextAttribute; unum_setTextAttribute ICU 2.0

◆ unum_setSymbol()

U_STABLE void U_EXPORT2 unum_setSymbol	(	UNumberFormat *	fmt,
		UNumberFormatSymbol	symbol,
		const UChar *	value,
		int32_t	length,
		UErrorCode *	status
	)

Set a symbol associated with a UNumberFormat. A UNumberFormat uses symbols to represent the special locale-dependent characters in a number, for example the percent sign. This API is not supported for rule-based formatters.

Parameters

fmt	The formatter to set.
symbol	The UNumberFormatSymbol constant for the symbol to set
value	The string to set the symbol to
length	The length of the string, or -1 for a zero-terminated string
status	A pointer to an UErrorCode to receive any errors.

See also: unum_getSymbol ICU 2.0

◆ unum_setTextAttribute()

U_STABLE void U_EXPORT2 unum_setTextAttribute	(	UNumberFormat *	fmt,
		UNumberFormatTextAttribute	tag,
		const UChar *	newValue,
		int32_t	newValueLength,
		UErrorCode *	status
	)

Set a text attribute associated with a UNumberFormat. An example of a text attribute is the suffix for positive numbers. Rule-based formatters only understand UNUM_DEFAULT_RULESET.

Parameters

fmt	The formatter to set.
tag	The attribute to set; one of UNUM_POSITIVE_PREFIX, UNUM_POSITIVE_SUFFIX, UNUM_NEGATIVE_PREFIX, UNUM_NEGATIVE_SUFFIX, UNUM_PADDING_CHARACTER, UNUM_CURRENCY_CODE, or UNUM_DEFAULT_RULESET.
newValue	The new value of attr.
newValueLength	The length of newValue, or -1 if null-terminated.
status	A pointer to an UErrorCode to receive any errors

See also: unum_getTextAttribute; unum_getAttribute; unum_setAttribute ICU 2.0

◆ unum_toPattern()

U_STABLE int32_t U_EXPORT2 unum_toPattern	(	const UNumberFormat *	fmt,
		UBool	isPatternLocalized,
		UChar *	result,
		int32_t	resultLength,
		UErrorCode *	status
	)

Extract the pattern from a UNumberFormat. The pattern will follow the DecimalFormat pattern syntax.

Parameters

fmt	The formatter to query.
isPatternLocalized	TRUE if the pattern should be localized, FALSE otherwise. This is ignored if the formatter is a rule-based formatter.
result	A pointer to a buffer to receive the pattern.
resultLength	The maximum size of result.
status	A pointer to an input-output UErrorCode.

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: unum_applyPattern; DecimalFormat ICU 2.0

Typedefs
typedef void *	UNumberFormat

typedef enum UNumberFormatStyle	UNumberFormatStyle

typedef enum UNumberFormatRoundingMode	UNumberFormatRoundingMode

typedef enum UNumberFormatPadPosition	UNumberFormatPadPosition

typedef enum UNumberCompactStyle	UNumberCompactStyle

typedef enum UCurrencySpacing	UCurrencySpacing

typedef enum UNumberFormatFields	UNumberFormatFields

typedef enum UNumberFormatAttribute	UNumberFormatAttribute

typedef enum UNumberFormatTextAttribute	UNumberFormatTextAttribute

typedef enum UNumberFormatSymbol	UNumberFormatSymbol

Typedefs

Enumerations

Functions

Detailed Description

Number Format C API

Typedef Documentation

◆ UCurrencySpacing

◆ UNumberCompactStyle

◆ UNumberFormat

◆ UNumberFormatAttribute

◆ UNumberFormatFields

◆ UNumberFormatPadPosition

◆ UNumberFormatRoundingMode

◆ UNumberFormatStyle

◆ UNumberFormatSymbol

◆ UNumberFormatTextAttribute

Enumeration Type Documentation

◆ UCurrencySpacing

◆ UNumberCompactStyle

◆ UNumberFormatAttribute

◆ UNumberFormatFields

◆ UNumberFormatPadPosition

◆ UNumberFormatRoundingMode

◆ UNumberFormatStyle

◆ UNumberFormatSymbol

◆ UNumberFormatTextAttribute

Function Documentation

◆ unum_applyPattern()

◆ unum_clone()

◆ unum_close()

◆ unum_countAvailable()

◆ unum_format()

◆ unum_formatDecimal()

◆ unum_formatDouble()

◆ unum_formatDoubleCurrency()

◆ unum_formatInt64()

◆ unum_formatUFormattable()

◆ unum_getAttribute()

◆ unum_getAvailable()

◆ unum_getDoubleAttribute()

◆ unum_getLocaleByType()

◆ unum_getSymbol()

◆ unum_getTextAttribute()

◆ unum_open()

◆ unum_parse()

◆ unum_parseDecimal()

◆ unum_parseDouble()

◆ unum_parseDoubleCurrency()

◆ unum_parseInt64()

◆ unum_parseToUFormattable()

◆ unum_setAttribute()

◆ unum_setDoubleAttribute()

◆ unum_setSymbol()

◆ unum_setTextAttribute()

◆ unum_toPattern()