ICU 62.1  62.1
Namespaces | Typedefs | Enumerations | Functions
unumberformatter.h File Reference

C-compatible API for localized number formatting; not recommended for C++. More...

#include "unicode/utypes.h"
#include "unicode/ufieldpositer.h"
#include "unicode/umisc.h"

Go to the source code of this file.

Namespaces

 icu
 File coll.h.
 

Typedefs

typedef enum UNumberUnitWidth UNumberUnitWidth
 An enum declaring how to render units, including currencies. More...
 
typedef enum UGroupingStrategy UGroupingStrategy
 An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). More...
 
typedef enum UNumberSignDisplay UNumberSignDisplay
 An enum declaring how to denote positive and negative numbers. More...
 
typedef enum UNumberDecimalSeparatorDisplay UNumberDecimalSeparatorDisplay
 An enum declaring how to render the decimal separator. More...
 
typedef struct UNumberFormatter UNumberFormatter
 
typedef struct UFormattedNumber UFormattedNumber
 

Enumerations

enum  UNumberUnitWidth {
  UNUM_UNIT_WIDTH_NARROW, UNUM_UNIT_WIDTH_SHORT, UNUM_UNIT_WIDTH_FULL_NAME, UNUM_UNIT_WIDTH_ISO_CODE,
  UNUM_UNIT_WIDTH_HIDDEN, UNUM_UNIT_WIDTH_COUNT
}
 An enum declaring how to render units, including currencies. More...
 
enum  UGroupingStrategy {
  UNUM_GROUPING_OFF, UNUM_GROUPING_MIN2, UNUM_GROUPING_AUTO, UNUM_GROUPING_ON_ALIGNED,
  UNUM_GROUPING_THOUSANDS, UNUM_GROUPING_COUNT
}
 An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). More...
 
enum  UNumberSignDisplay {
  UNUM_SIGN_AUTO, UNUM_SIGN_ALWAYS, UNUM_SIGN_NEVER, UNUM_SIGN_ACCOUNTING,
  UNUM_SIGN_ACCOUNTING_ALWAYS, UNUM_SIGN_EXCEPT_ZERO, UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO, UNUM_SIGN_COUNT
}
 An enum declaring how to denote positive and negative numbers. More...
 
enum  UNumberDecimalSeparatorDisplay { UNUM_DECIMAL_SEPARATOR_AUTO, UNUM_DECIMAL_SEPARATOR_ALWAYS, UNUM_DECIMAL_SEPARATOR_COUNT }
 An enum declaring how to render the decimal separator. More...
 

Functions

UNumberFormatter * unumf_openForSkeletonAndLocale (const UChar *skeleton, int32_t skeletonLen, const char *locale, UErrorCode *ec)
 Creates a new UNumberFormatter for the given skeleton string and locale. More...
 
UFormattedNumber * unumf_openResult (UErrorCode *ec)
 Creates a new UFormattedNumber for holding the result of a number formatting operation. More...
 
void unumf_formatInt (const UNumberFormatter *uformatter, int64_t value, UFormattedNumber *uresult, UErrorCode *ec)
 Uses a UNumberFormatter to format an integer to a UFormattedNumber. More...
 
void unumf_formatDouble (const UNumberFormatter *uformatter, double value, UFormattedNumber *uresult, UErrorCode *ec)
 Uses a UNumberFormatter to format a double to a UFormattedNumber. More...
 
void unumf_formatDecimal (const UNumberFormatter *uformatter, const char *value, int32_t valueLen, UFormattedNumber *uresult, UErrorCode *ec)
 Uses a UNumberFormatter to format a decimal number to a UFormattedNumber. More...
 
int32_t unumf_resultToString (const UFormattedNumber *uresult, UChar *buffer, int32_t bufferCapacity, UErrorCode *ec)
 Extracts the result number string out of a UFormattedNumber to a UChar buffer if possible. More...
 
UBool unumf_resultNextFieldPosition (const UFormattedNumber *uresult, UFieldPosition *ufpos, UErrorCode *ec)
 Determines the start and end indices of the next occurrence of the given field in the output string. More...
 
void unumf_resultGetAllFieldPositions (const UFormattedNumber *uresult, UFieldPositionIterator *ufpositer, UErrorCode *ec)
 Populates the given iterator with all fields in the formatted output string. More...
 
void unumf_close (UNumberFormatter *uformatter)
 Releases the UNumberFormatter created by unumf_openForSkeletonAndLocale(). More...
 
void unumf_closeResult (UFormattedNumber *uresult)
 Releases the UFormattedNumber created by unumf_openResult(). More...
 

Detailed Description

C-compatible API for localized number formatting; not recommended for C++.

This is the C-compatible version of the NumberFormatter API introduced in ICU 60. C++ users should include unicode/numberformatter.h and use the proper C++ APIs.

The C API accepts a number skeleton string for specifying the settings for formatting, which covers a very large subset of all possible number formatting features. For more information on number skeleton strings, see unicode/numberformatter.h.

When using UNumberFormatter, which is treated as immutable, the results are exported to a mutable UFormattedNumber object, which you subsequently use for populating your string buffer or iterating over the fields.

Example code:

// Setup:
UErrorCode ec = U_ZERO_ERROR;
UNumberFormatter* uformatter = unumf_openForSkeletonAndLocale(u"precision-integer", -1, "en", &ec);
UFormattedNumber* uresult = unumf_openResult(&ec);
if (U_FAILURE(ec)) { return; }
// Format a double:
unumf_formatDouble(uformatter, 5142.3, uresult, &ec);
if (U_FAILURE(ec)) { return; }
// Export the string to a malloc'd buffer:
int32_t len = unumf_resultToString(uresult, NULL, 0, &ec);
// at this point, ec == U_BUFFER_OVERFLOW_ERROR
ec = U_ZERO_ERROR;
UChar* buffer = (UChar*) malloc((len+1)*sizeof(UChar));
unumf_resultToString(uresult, buffer, len+1, &ec);
if (U_FAILURE(ec)) { return; }
// buffer should equal "5,142"
// Cleanup:
unumf_close(uformatter);
unumf_closeResult(uresult);
free(buffer);

If you are a C++ user linking against the C libraries, you can use the LocalPointer versions of these APIs. The following example uses LocalPointer with the decimal number and field position APIs:

// Setup:
LocalUNumberFormatterPointer uformatter(unumf_openForSkeletonAndLocale(u"percent", -1, "en", &ec));
LocalUFormattedNumberPointer uresult(unumf_openResult(&ec));
if (U_FAILURE(ec)) { return; }
// Format a decimal number:
unumf_formatDecimal(uformatter.getAlias(), "9.87E-3", -1, uresult.getAlias(), &ec);
if (U_FAILURE(ec)) { return; }
// Get the location of the percent sign:
UFieldPosition ufpos = {UNUM_PERCENT_FIELD, 0, 0};
unumf_resultNextFieldPosition(uresult.getAlias(), &ufpos, &ec);
// ufpos should contain beginIndex=7 and endIndex=8 since the string is "0.00987%"
// No need to do any cleanup since we are using LocalPointer.

Definition in file unumberformatter.h.

Typedef Documentation

◆ UGroupingStrategy

An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).

The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in en-IN:

  • OFF: 1234 and 12345
  • MIN2: 1234 and 12,34,567
  • AUTO: 1,234 and 12,34,567
  • ON_ALIGNED: 1,234 and 12,34,567
  • THOUSANDS: 1,234 and 1,234,567

The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.

Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.

Draft:
This API may be changed in the future versions and was introduced in ICU 61 – TODO: This should be renamed to UNumberGroupingStrategy before promoting to stable, for consistency with the other enums.

◆ UNumberDecimalSeparatorDisplay

An enum declaring how to render the decimal separator.

  • UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1"
  • UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1"

◆ UNumberSignDisplay

An enum declaring how to denote positive and negative numbers.

Example outputs when formatting 123, 0, and -123 in en-US:

  • AUTO: "123", "0", and "-123"
  • ALWAYS: "+123", "+0", and "-123"
  • NEVER: "123", "0", and "123"
  • ACCOUNTING: "$123", "$0", and "($123)"
  • ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)"
  • EXCEPT_ZERO: "+123", "0", and "-123"
  • ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)"

The exact format, including the position and the code point of the sign, differ by locale.

Draft:
This API may be changed in the future versions and was introduced in ICU 60

◆ UNumberUnitWidth

An enum declaring how to render units, including currencies.

Example outputs when formatting 123 USD and 123 meters in en-CA:

  • NARROW*: "$123.00" and "123 m"
  • SHORT: "US$ 123.00" and "123 m"
  • FULL_NAME: "123.00 US dollars" and "123 meters"
  • ISO_CODE: "USD 123.00" and undefined behavior
  • HIDDEN: "123.00" and "123"

This enum is similar to com.ibm.icu.text.MeasureFormat.FormatWidth.

Draft:
This API may be changed in the future versions and was introduced in ICU 60

Enumeration Type Documentation

◆ UGroupingStrategy

An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).

The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in en-IN:

  • OFF: 1234 and 12345
  • MIN2: 1234 and 12,34,567
  • AUTO: 1,234 and 12,34,567
  • ON_ALIGNED: 1,234 and 12,34,567
  • THOUSANDS: 1,234 and 1,234,567

The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.

Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.

Draft:
This API may be changed in the future versions and was introduced in ICU 61 – TODO: This should be renamed to UNumberGroupingStrategy before promoting to stable, for consistency with the other enums.
Enumerator
UNUM_GROUPING_OFF 

Do not display grouping separators in any locale.

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_GROUPING_MIN2 

Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a minimum of two digits before the first separator).

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_GROUPING_AUTO 

Display grouping using the default strategy for all locales.

This is the default behavior.

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_GROUPING_ON_ALIGNED 

Always display the grouping separator on values of at least 1000.

This option ignores the locale data that restricts or disables grouping, described in MIN2 and AUTO. This option may be useful to normalize the alignment of numbers, such as in a spreadsheet.

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_GROUPING_THOUSANDS 

Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater.

Do not use locale data for determining the grouping strategy.

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_GROUPING_COUNT 

One more than the highest UGroupingStrategy value.

Internal:
Do not use. This API is for internal use only. ICU 62: The numeric value may change over time; see ICU ticket #12420.

Definition at line 196 of file unumberformatter.h.

◆ UNumberDecimalSeparatorDisplay

An enum declaring how to render the decimal separator.

  • UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1"
  • UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1"
Enumerator
UNUM_DECIMAL_SEPARATOR_AUTO 

Show the decimal separator when there are one or more digits to display after the separator, and do not show it otherwise.

This is the default behavior.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_DECIMAL_SEPARATOR_ALWAYS 

Always show the decimal separator, even if there are no digits to display after the separator.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_DECIMAL_SEPARATOR_COUNT 

One more than the highest UNumberDecimalSeparatorDisplay value.

Internal:
Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420.

Definition at line 375 of file unumberformatter.h.

◆ UNumberSignDisplay

An enum declaring how to denote positive and negative numbers.

Example outputs when formatting 123, 0, and -123 in en-US:

  • AUTO: "123", "0", and "-123"
  • ALWAYS: "+123", "+0", and "-123"
  • NEVER: "123", "0", and "123"
  • ACCOUNTING: "$123", "$0", and "($123)"
  • ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)"
  • EXCEPT_ZERO: "+123", "0", and "-123"
  • ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)"

The exact format, including the position and the code point of the sign, differ by locale.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
Enumerator
UNUM_SIGN_AUTO 

Show the minus sign on negative numbers, and do not show the sign on positive numbers.

This is the default behavior.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_SIGN_ALWAYS 

Show the minus sign on negative numbers and the plus sign on positive numbers, including zero.

To hide the sign on zero, see UNUM_SIGN_EXCEPT_ZERO.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_SIGN_NEVER 

Do not show the sign on positive or negative numbers.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_SIGN_ACCOUNTING 

Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.

The accounting format is defined in CLDR and varies by locale; in many Western locales, the format is a pair of parentheses around the number.

Note: Since CLDR defines the accounting format in the monetary context only, this option falls back to the AUTO sign display strategy when formatting without a currency unit. This limitation may be lifted in the future.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_SIGN_ACCOUNTING_ALWAYS 

Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers, including zero.

For more information on the accounting format, see the ACCOUNTING sign display strategy. To hide the sign on zero, see UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_SIGN_EXCEPT_ZERO 

Show the minus sign on negative numbers and the plus sign on positive numbers.

Do not show a sign on zero.

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO 

Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers.

Do not show a sign on zero. For more information on the accounting format, see the ACCOUNTING sign display strategy.

Draft:
This API may be changed in the future versions and was introduced in ICU 61
UNUM_SIGN_COUNT 

One more than the highest UNumberSignDisplay value.

Internal:
Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420.

Definition at line 289 of file unumberformatter.h.

◆ UNumberUnitWidth

An enum declaring how to render units, including currencies.

Example outputs when formatting 123 USD and 123 meters in en-CA:

  • NARROW*: "$123.00" and "123 m"
  • SHORT: "US$ 123.00" and "123 m"
  • FULL_NAME: "123.00 US dollars" and "123 meters"
  • ISO_CODE: "USD 123.00" and undefined behavior
  • HIDDEN: "123.00" and "123"

This enum is similar to com.ibm.icu.text.MeasureFormat.FormatWidth.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
Enumerator
UNUM_UNIT_WIDTH_NARROW 

Print an abbreviated version of the unit name.

Similar to SHORT, but always use the shortest available abbreviation or symbol. This option can be used when the context hints at the identity of the unit. For more information on the difference between NARROW and SHORT, see SHORT.

In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤" placeholder for currencies.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_UNIT_WIDTH_SHORT 

Print an abbreviated version of the unit name.

Similar to NARROW, but use a slightly wider abbreviation or symbol when there may be ambiguity. This is the default behavior.

For example, in es-US, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form is "{0}°", since Fahrenheit is the customary unit for temperature in that locale.

In CLDR, this option corresponds to the "Short" format for measure units and the "¤" placeholder for currencies.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_UNIT_WIDTH_FULL_NAME 

Print the full name of the unit, without any abbreviations.

In CLDR, this option corresponds to the default format for measure units and the "¤¤¤" placeholder for currencies.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_UNIT_WIDTH_ISO_CODE 

Use the three-digit ISO XXX code in place of the symbol for displaying currencies.

The behavior of this option is currently undefined for use with measure units.

In CLDR, this option corresponds to the "¤¤" placeholder for currencies.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_UNIT_WIDTH_HIDDEN 

Format the number according to the specified unit, but do not display the unit.

For currencies, apply monetary symbols and formats as with SHORT, but omit the currency symbol. For measure units, the behavior is equivalent to not specifying the unit at all.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
UNUM_UNIT_WIDTH_COUNT 

One more than the highest UNumberUnitWidth value.

Internal:
Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420.

Definition at line 98 of file unumberformatter.h.

Function Documentation

◆ unumf_close()

void unumf_close ( UNumberFormatter *  uformatter)

Releases the UNumberFormatter created by unumf_openForSkeletonAndLocale().

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uformatterAn object created by unumf_openForSkeletonAndLocale().
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_closeResult()

void unumf_closeResult ( UFormattedNumber *  uresult)

Releases the UFormattedNumber created by unumf_openResult().

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uresultAn object created by unumf_openResult().
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_formatDecimal()

void unumf_formatDecimal ( const UNumberFormatter *  uformatter,
const char *  value,
int32_t  valueLen,
UFormattedNumber *  uresult,
UErrorCode ec 
)

Uses a UNumberFormatter to format a decimal number to a UFormattedNumber.

A string, field position, and other information can be retrieved from the UFormattedNumber.

The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.

The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uformatterA formatter object created by unumf_openForSkeletonAndLocale or similar.
valueThe numeric string to be formatted.
valueLenThe length of the numeric string, or -1 if it is NUL-terminated.
uresultThe object that will be mutated to store the result; see unumf_openResult.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_formatDouble()

void unumf_formatDouble ( const UNumberFormatter *  uformatter,
double  value,
UFormattedNumber *  uresult,
UErrorCode ec 
)

Uses a UNumberFormatter to format a double to a UFormattedNumber.

A string, field position, and other information can be retrieved from the UFormattedNumber.

The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uformatterA formatter object created by unumf_openForSkeletonAndLocale or similar.
valueThe number to be formatted.
uresultThe object that will be mutated to store the result; see unumf_openResult.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_formatInt()

void unumf_formatInt ( const UNumberFormatter *  uformatter,
int64_t  value,
UFormattedNumber *  uresult,
UErrorCode ec 
)

Uses a UNumberFormatter to format an integer to a UFormattedNumber.

A string, field position, and other information can be retrieved from the UFormattedNumber.

The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uformatterA formatter object created by unumf_openForSkeletonAndLocale or similar.
valueThe number to be formatted.
uresultThe object that will be mutated to store the result; see unumf_openResult.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_openForSkeletonAndLocale()

UNumberFormatter* unumf_openForSkeletonAndLocale ( const UChar skeleton,
int32_t  skeletonLen,
const char *  locale,
UErrorCode ec 
)

Creates a new UNumberFormatter for the given skeleton string and locale.

This is currently the only method for creating a new UNumberFormatter.

Objects of type UNumberFormatter returned by this method are threadsafe.

For more details on skeleton strings, see the documentation in numberformatter.h. For more details on the usage of this API, see the documentation at the top of unumberformatter.h.

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
skeletonThe skeleton string, like u"percent precision-integer"
skeletonLenThe number of UChars in the skeleton string, or -1 it it is NUL-terminated.
localeThe NUL-terminated locale ID.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_openResult()

UFormattedNumber* unumf_openResult ( UErrorCode ec)

Creates a new UFormattedNumber for holding the result of a number formatting operation.

Objects of type UFormattedNumber are not guaranteed to be threadsafe.

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_resultGetAllFieldPositions()

void unumf_resultGetAllFieldPositions ( const UFormattedNumber *  uresult,
UFieldPositionIterator ufpositer,
UErrorCode ec 
)

Populates the given iterator with all fields in the formatted output string.

This allows you to determine the locations of the integer part, fraction part, and sign.

If you need information on only one field, use unumf_resultNextFieldPosition().

Parameters
uresultThe object containing the formatted number.
fpositerA pointer to a UFieldPositionIterator created by ufieldpositer_open. Iteration information already present in the UFieldPositionIterator is deleted, and the iterator is reset to apply to the fields in the formatted string created by this function call. The field values and indexes returned by ufieldpositer_next represent fields denoted by the UNumberFormatFields enum. Fields are not returned in a guaranteed order. Fields cannot overlap, but they may nest. For example, 1234 could format as "1,234" which might consist of a grouping separator field for ',' and an integer field encompassing the entire string.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_resultNextFieldPosition()

UBool unumf_resultNextFieldPosition ( const UFormattedNumber *  uresult,
UFieldPosition ufpos,
UErrorCode ec 
)

Determines the start and end indices of the next occurrence of the given field in the output string.

This allows you to determine the locations of, for example, the integer part, fraction part, or symbols.

If a field occurs just once, calling this method will find that occurrence and return it. If a field occurs multiple times, this method may be called repeatedly with the following pattern:

UFieldPosition ufpos = {UNUM_GROUPING_SEPARATOR_FIELD, 0, 0};
while (unumf_resultNextFieldPosition(uresult, ufpos, &ec)) {
  // do something with ufpos.
}

This method is useful if you know which field to query. If you want all available field position information, use unumf_resultGetAllFieldPositions().

NOTE: All fields of the UFieldPosition must be initialized before calling this method.

Parameters
fieldPositionInput+output variable. On input, the "field" property determines which field to look up, and the "endIndex" property determines where to begin the search. On output, the "beginIndex" field is set to the beginning of the first occurrence of the field after the input "endIndex", and "endIndex" is set to the end of that occurrence of the field (exclusive index). If a field position is not found, the FieldPosition is not changed and the method returns FALSE.
ecSet if an error occurs.
Draft:
This API may be changed in the future versions and was introduced in ICU 62

◆ unumf_resultToString()

int32_t unumf_resultToString ( const UFormattedNumber *  uresult,
UChar buffer,
int32_t  bufferCapacity,
UErrorCode ec 
)

Extracts the result number string out of a UFormattedNumber to a UChar buffer if possible.

If bufferCapacity is greater than the required length, a terminating NUL is written. If bufferCapacity is less than the required length, an error code is set.

NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.

Parameters
uresultThe object containing the formatted number.
bufferWhere to save the string output.
bufferCapacityThe number of UChars available in the buffer.
ecSet if an error occurs.
Returns
The required length.
Draft:
This API may be changed in the future versions and was introduced in ICU 62