# utypes.h File Reference

Basic definitions for ICU, for both C and C++ APIs. More...

`#include "unicode/umachine.h"`
`#include "unicode/utf.h"`
`#include "unicode/uversion.h"`
`#include "unicode/uconfig.h"`

Go to the source code of this file.

## Defines
#define | U_SHOW_CPLUSPLUS_API 0
#define | U_ASCII_FAMILY 0
| U_CHARSET_FAMILY is equal to this value when the platform is an ASCII based platform.
#define | U_EBCDIC_FAMILY 1
| U_CHARSET_FAMILY is equal to this value when the platform is an EBCDIC based platform.
#define | U_CHARSET_FAMILY 0
#define | U_CHARSET_IS_UTF8 0
| Hardcode the default charset to UTF-8.
#define | U_ICUDATA_TYPE_LETTER "l"
| This is a platform-dependent string containing one letter: b for big-endian, ASCII-family platforms l for little-endian, ASCII-family platforms e for big-endian, EBCDIC-family platforms This letter is part of the common data file name.
#define | U_ICUDATA_TYPE_LITLETTER l
| The non-string form of U_ICUDATA_TYPE_LETTER.
#define | U_ICUDATA_NAME "icudt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER
| A single string literal containing the icudata stub name.
#define | U_USRDATA_NAME "usrdt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER
#define | U_USE_USRDATA 1
#define | U_ICUDATA_ENTRY_POINT U_DEF2_ICUDATA_ENTRY_POINT(U_ICU_VERSION_MAJOR_NUM, U_ICU_VERSION_MINOR_NUM)
| U_ICU_ENTRY_POINT is the name of the DLL entry point to the ICU data library.
#define | U_DEF2_ICUDATA_ENTRY_POINT(major, minor) U_DEF_ICUDATA_ENTRY_POINT(major, minor)
| Do not use.
#define | U_DEF_ICUDATA_ENTRY_POINT(major, minor) icudt##major##minor##_dat
| Do not use.
#define | U_CALLCONV U_EXPORT2
| Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to make sure that the calling convention is compatible.
#define | NULL ((void *)0)
| Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.
#define | U_MILLIS_PER_SECOND (1000)
| The number of milliseconds per second.
#define | U_MILLIS_PER_MINUTE (60000)
| The number of milliseconds per minute.
#define | U_MILLIS_PER_HOUR (3600000)
| The number of milliseconds per hour.
#define | U_MILLIS_PER_DAY (86400000)
| The number of milliseconds per day.
#define | U_DATA_API U_IMPORT
| Set to export library symbols from inside the stubdata library, and to import them from outside.
#define | U_COMMON_API U_IMPORT
| Set to export library symbols from inside the common library, and to import them from outside.
#define | U_I18N_API U_IMPORT
| Set to export library symbols from inside the i18n library, and to import them from outside.
#define | U_LAYOUT_API U_IMPORT
| Set to export library symbols from inside the layout engine library, and to import them from outside.
#define | U_LAYOUTEX_API U_IMPORT
| Set to export library symbols from inside the layout extensions library, and to import them from outside.
#define | U_IO_API U_IMPORT
| Set to export library symbols from inside the ustdio library, and to import them from outside.
#define | U_TOOLUTIL_API U_IMPORT
| Set to export library symbols from inside the toolutil library, and to import them from outside.
#define | U_STANDARD_CPP_NAMESPACE
| Control of C++ Namespace.
#define | U_SUCCESS(x) ((x)<=U_ZERO_ERROR)
| Does the error code indicate success?
#define | U_FAILURE(x) ((x)>U_ZERO_ERROR)
| Does the error code indicate a failure?
## Typedefs
typedef double | UDate
| Date and Time data type.
typedef void * | UClassID
| UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ compilers.
## Enumerations
enum | UErrorCode { U_USING_FALLBACK_WARNING = -128, U_ERROR_WARNING_START = -128, U_USING_DEFAULT_WARNING = -127, U_SAFECLONE_ALLOCATED_WARNING = -126, U_STATE_OLD_WARNING = -125, U_STRING_NOT_TERMINATED_WARNING = -124, U_SORT_KEY_TOO_SHORT_WARNING = -123, U_AMBIGUOUS_ALIAS_WARNING = -122, U_DIFFERENT_UCA_VERSION = -121, U_PLUGIN_CHANGED_LEVEL_WARNING = -120, U_ERROR_WARNING_LIMIT, U_ZERO_ERROR = 0, U_ILLEGAL_ARGUMENT_ERROR = 1, U_MISSING_RESOURCE_ERROR = 2, U_INVALID_FORMAT_ERROR = 3, U_FILE_ACCESS_ERROR = 4, U_INTERNAL_PROGRAM_ERROR = 5, U_MESSAGE_PARSE_ERROR = 6, U_MEMORY_ALLOCATION_ERROR = 7, U_INDEX_OUTOFBOUNDS_ERROR = 8, U_PARSE_ERROR = 9, U_INVALID_CHAR_FOUND = 10, U_TRUNCATED_CHAR_FOUND = 11, U_ILLEGAL_CHAR_FOUND = 12, U_INVALID_TABLE_FORMAT = 13, U_INVALID_TABLE_FILE = 14, U_BUFFER_OVERFLOW_ERROR = 15, U_UNSUPPORTED_ERROR = 16, U_RESOURCE_TYPE_MISMATCH = 17, U_ILLEGAL_ESCAPE_SEQUENCE = 18, U_UNSUPPORTED_ESCAPE_SEQUENCE = 19, U_NO_SPACE_AVAILABLE = 20, U_CE_NOT_FOUND_ERROR = 21, U_PRIMARY_TOO_LONG_ERROR = 22, U_STATE_TOO_OLD_ERROR = 23, U_TOO_MANY_ALIASES_ERROR = 24, U_ENUM_OUT_OF_SYNC_ERROR = 25, U_INVARIANT_CONVERSION_ERROR = 26, U_INVALID_STATE_ERROR = 27, U_COLLATOR_VERSION_MISMATCH = 28, U_USELESS_COLLATOR_ERROR = 29, U_NO_WRITE_PERMISSION = 30, U_STANDARD_ERROR_LIMIT, U_BAD_VARIABLE_DEFINITION = 0x10000, U_PARSE_ERROR_START = 0x10000, U_MALFORMED_RULE, U_MALFORMED_SET, U_MALFORMED_SYMBOL_REFERENCE, U_MALFORMED_UNICODE_ESCAPE, U_MALFORMED_VARIABLE_DEFINITION, U_MALFORMED_VARIABLE_REFERENCE, U_MISMATCHED_SEGMENT_DELIMITERS, U_MISPLACED_ANCHOR_START, U_MISPLACED_CURSOR_OFFSET, U_MISPLACED_QUANTIFIER, U_MISSING_OPERATOR, U_MISSING_SEGMENT_CLOSE, U_MULTIPLE_ANTE_CONTEXTS, U_MULTIPLE_CURSORS, U_MULTIPLE_POST_CONTEXTS, U_TRAILING_BACKSLASH, U_UNDEFINED_SEGMENT_REFERENCE, U_UNDEFINED_VARIABLE, U_UNQUOTED_SPECIAL, U_UNTERMINATED_QUOTE, U_RULE_MASK_ERROR, U_MISPLACED_COMPOUND_FILTER, U_MULTIPLE_COMPOUND_FILTERS, U_INVALID_RBT_SYNTAX, U_INVALID_PROPERTY_PATTERN, U_MALFORMED_PRAGMA, U_UNCLOSED_SEGMENT, U_ILLEGAL_CHAR_IN_SEGMENT, U_VARIABLE_RANGE_EXHAUSTED, U_VARIABLE_RANGE_OVERLAP, U_ILLEGAL_CHARACTER, U_INTERNAL_TRANSLITERATOR_ERROR, U_INVALID_ID, U_INVALID_FUNCTION, U_PARSE_ERROR_LIMIT, U_UNEXPECTED_TOKEN = 0x10100, U_FMT_PARSE_ERROR_START = 0x10100, U_MULTIPLE_DECIMAL_SEPARATORS, U_MULTIPLE_DECIMAL_SEPERATORS = U_MULTIPLE_DECIMAL_SEPARATORS, U_MULTIPLE_EXPONENTIAL_SYMBOLS, U_MALFORMED_EXPONENTIAL_PATTERN, U_MULTIPLE_PERCENT_SYMBOLS, U_MULTIPLE_PERMILL_SYMBOLS, U_MULTIPLE_PAD_SPECIFIERS, U_PATTERN_SYNTAX_ERROR, U_ILLEGAL_PAD_POSITION, U_UNMATCHED_BRACES, U_UNSUPPORTED_PROPERTY, U_UNSUPPORTED_ATTRIBUTE, U_ARGUMENT_TYPE_MISMATCH, U_DUPLICATE_KEYWORD, U_UNDEFINED_KEYWORD, U_DEFAULT_KEYWORD_MISSING, U_DECIMAL_NUMBER_SYNTAX_ERROR, U_FMT_PARSE_ERROR_LIMIT, U_BRK_INTERNAL_ERROR = 0x10200, U_BRK_ERROR_START = 0x10200, U_BRK_HEX_DIGITS_EXPECTED, U_BRK_SEMICOLON_EXPECTED, U_BRK_RULE_SYNTAX, U_BRK_UNCLOSED_SET, U_BRK_ASSIGN_ERROR, U_BRK_VARIABLE_REDFINITION, U_BRK_MISMATCHED_PAREN, U_BRK_NEW_LINE_IN_QUOTED_STRING, U_BRK_UNDEFINED_VARIABLE, U_BRK_INIT_ERROR, U_BRK_RULE_EMPTY_SET, U_BRK_UNRECOGNIZED_OPTION, U_BRK_MALFORMED_RULE_TAG, U_BRK_ERROR_LIMIT, U_REGEX_INTERNAL_ERROR = 0x10300, U_REGEX_ERROR_START = 0x10300, U_REGEX_RULE_SYNTAX, U_REGEX_INVALID_STATE, U_REGEX_BAD_ESCAPE_SEQUENCE, U_REGEX_PROPERTY_SYNTAX, U_REGEX_UNIMPLEMENTED, U_REGEX_MISMATCHED_PAREN, U_REGEX_NUMBER_TOO_BIG, U_REGEX_BAD_INTERVAL, U_REGEX_MAX_LT_MIN, U_REGEX_INVALID_BACK_REF, U_REGEX_INVALID_FLAG, U_REGEX_LOOK_BEHIND_LIMIT, U_REGEX_SET_CONTAINS_STRING, U_REGEX_OCTAL_TOO_BIG, U_REGEX_MISSING_CLOSE_BRACKET, U_REGEX_INVALID_RANGE, U_REGEX_STACK_OVERFLOW, U_REGEX_TIME_OUT, U_REGEX_STOPPED_BY_CALLER, U_REGEX_ERROR_LIMIT, U_IDNA_PROHIBITED_ERROR = 0x10400, U_IDNA_ERROR_START = 0x10400, U_IDNA_UNASSIGNED_ERROR, U_IDNA_CHECK_BIDI_ERROR, U_IDNA_STD3_ASCII_RULES_ERROR, U_IDNA_ACE_PREFIX_ERROR, U_IDNA_VERIFICATION_ERROR, U_IDNA_LABEL_TOO_LONG_ERROR, U_IDNA_ZERO_LENGTH_LABEL_ERROR, U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR, U_IDNA_ERROR_LIMIT, U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR, U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR, U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR, U_PLUGIN_ERROR_START = 0x10500, U_PLUGIN_TOO_HIGH = 0x10500, U_PLUGIN_DIDNT_SET_LEVEL, U_PLUGIN_ERROR_LIMIT, U_ERROR_LIMIT = U_PLUGIN_ERROR_LIMIT }
| Error code to replace exception handling, so that the code is compatible with all C++ compilers, and to use the same mechanism for C and C++. More...
## Functions
const char * | u_errorName (UErrorCode code)
| Return a string for a UErrorCode value.

## Detailed Description

Basic definitions for ICU, for both C and C++ APIs.

This file defines basic types, constants, and enumerations directly or indirectly by including other header files, especially utf.h for the basic character and string definitions and umachine.h for consistent integer and other types.

Definition in file utypes.h.

## Define Documentation

#define NULL ((void *)0)

Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.

Stable:
  ICU 2.0

Definition at line 292 of file utypes.h.

Referenced by StringPiece::clear(), UnicodeSet::isFrozen(), UnicodeString::remove(), UnicodeString::removeBetween(), and UnicodeString::retainBetween().

#define U_ASCII_FAMILY 0

U_CHARSET_FAMILY is equal to this value when the platform is an ASCII based platform.

Stable:
  ICU 2.0

Definition at line 109 of file utypes.h.

#define U_CALLCONV U_EXPORT2

Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to make sure that the calling convention is compatible.

This is only used for non-ICU-API functions. When a function is a public ICU API, you must use the U_CAPI and U_EXPORT2 qualifiers.

Stable:
  ICU 2.0

Definition at line 280 of file utypes.h.

#define U_CHARSET_FAMILY 0

These definitions allow to specify the encoding of text in the char data type as defined by the platform and the compiler. It is enough to determine the code point values of "invariant characters", which are the ones shared by all encodings that are in use on a given platform.

Those "invariant characters" should be all the uppercase and lowercase latin letters, the digits, the space, and "basic punctuation". Also, '\n', '\r', '\t' should be available.

The list of "invariant characters" is:

        A-Z  a-z  0-9  SPACE  "  %  &amp;  '  (  )  *  +  ,  -  .  /  :  ;  <  =  >  ?  _

(52 letters + 10 numbers + 20 punc/sym/space = 82 total)

This matches the IBM Syntactic Character Set (CS 640).

In other words, all the graphic characters in 7-bit ASCII should be safely accessible except the following:

        '\' <backslash>
        '[' <left bracket>
        ']' <right bracket>
        '{' <left brace>
        '}' <right brace>
        '^' <circumflex>
        '~' <tilde>
        '!' <exclamation mark>
        '#' <number sign>
        '|' <vertical line>
        '$' <dollar sign>
        '@' <commercial at>
        '`' <grave accent>

Stable:
  ICU 2.0

Definition at line 161 of file utypes.h.

#define U_CHARSET_IS_UTF8 0

Hardcode the default charset to UTF-8.

If this is set to 1, then

- ICU will assume that all non-invariant char*, StringPiece, std::string etc. contain UTF-8 text, regardless of what the system API uses
- some ICU code will use fast functions like u_strFromUTF8() rather than the more general and more heavy-weight conversion API (ucnv.h)
- ucnv_getDefaultName() always returns "UTF-8"
- ucnv_setDefaultName() is disabled and will not change the default charset
- static builds of ICU are smaller
- more functionality is available with the UCONFIG_NO_CONVERSION build-time configuration option (see unicode/uconfig.h)
- the UCONFIG_NO_CONVERSION build option in uconfig.h is more usable

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

See also:
  UCONFIG_NO_CONVERSION

Definition at line 185 of file utypes.h.

#define U_COMMON_API U_IMPORT

Set to export library symbols from inside the common library, and to import them from outside.

Stable:
  ICU 2.0

Definition at line 500 of file utypes.h.

#define U_DATA_API U_IMPORT

Set to export library symbols from inside the stubdata library, and to import them from outside.

Stable:
  ICU 3.0

Definition at line 499 of file utypes.h.

#define U_DEF2_ICUDATA_ENTRY_POINT | ( | major,
|  | minor |  | ) | U_DEF_ICUDATA_ENTRY_POINT(major, minor)

Do not use.

Internal:
  Do not use. This API is for internal use only.

Definition at line 256 of file utypes.h.

#define U_DEF_ICUDATA_ENTRY_POINT | ( | major,
|  | minor |  | ) | icudt##major##minor##_dat

Do not use.

Internal:
  Do not use. This API is for internal use only.

Definition at line 263 of file utypes.h.

#define U_EBCDIC_FAMILY 1

U_CHARSET_FAMILY is equal to this value when the platform is an EBCDIC based platform.

Stable:
  ICU 2.0

Definition at line 115 of file utypes.h.

#define U_FAILURE | ( | x |  | ) | ((x)>U_ZERO_ERROR)

Does the error code indicate a failure?

Stable:
  ICU 2.0

Definition at line 852 of file utypes.h.

Referenced by ErrorCode::isFailure().

#define U_I18N_API U_IMPORT

Set to export library symbols from inside the i18n library, and to import them from outside.

Stable:
  ICU 2.0

Definition at line 501 of file utypes.h.

#define U_ICUDATA_ENTRY_POINT U_DEF2_ICUDATA_ENTRY_POINT(U_ICU_VERSION_MAJOR_NUM, U_ICU_VERSION_MINOR_NUM)

U_ICU_ENTRY_POINT is the name of the DLL entry point to the ICU data library.

Defined as a literal, not a string. Tricky Preprocessor use - ## operator replaces macro paramters with the literal string from the corresponding macro invocation, _before_ other macro substitutions. Need a nested #defines to get the actual version numbers rather than the literal text U_ICU_VERSION_MAJOR_NUM into the name. The net result will be something of the form #define U_ICU_ENTRY_POINT icudt19_dat

Stable:
  ICU 2.4

Definition at line 250 of file utypes.h.

#define U_ICUDATA_NAME "icudt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER

A single string literal containing the icudata stub name.

i.e. 'icudt18e' for ICU 1.8.x on EBCDIC, etc..

Stable:
  ICU 2.0

Internal:
  Do not use. This API is for internal use only.

Definition at line 235 of file utypes.h.

#define U_ICUDATA_TYPE_LETTER "l"

This is a platform-dependent string containing one letter:

- b for big-endian, ASCII-family platforms
- l for little-endian, ASCII-family platforms
- e for big-endian, EBCDIC-family platforms This letter is part of the common data file name.

Stable:
  ICU 2.0

Definition at line 225 of file utypes.h.

#define U_ICUDATA_TYPE_LITLETTER l

The non-string form of U_ICUDATA_TYPE_LETTER.

Stable:
  ICU 2.0

Definition at line 226 of file utypes.h.

#define U_IO_API U_IMPORT

Set to export library symbols from inside the ustdio library, and to import them from outside.

Stable:
  ICU 2.0

Definition at line 504 of file utypes.h.

#define U_LAYOUT_API U_IMPORT

Set to export library symbols from inside the layout engine library, and to import them from outside.

Stable:
  ICU 2.0

Definition at line 502 of file utypes.h.

#define U_LAYOUTEX_API U_IMPORT

Set to export library symbols from inside the layout extensions library, and to import them from outside.

Stable:
  ICU 2.6

Definition at line 503 of file utypes.h.

#define U_MILLIS_PER_DAY (86400000)

The number of milliseconds per day.

Stable:
  ICU 2.0

Definition at line 316 of file utypes.h.

#define U_MILLIS_PER_HOUR (3600000)

The number of milliseconds per hour.

Stable:
  ICU 2.0

Definition at line 314 of file utypes.h.

#define U_MILLIS_PER_MINUTE (60000)

The number of milliseconds per minute.

Stable:
  ICU 2.0

Definition at line 312 of file utypes.h.

#define U_MILLIS_PER_SECOND (1000)

The number of milliseconds per second.

Stable:
  ICU 2.0

Definition at line 310 of file utypes.h.

#define U_SHOW_CPLUSPLUS_API 0

Internal:
  Do not use. This API is for internal use only.

Definition at line 62 of file utypes.h.

#define U_STANDARD_CPP_NAMESPACE

Control of C++ Namespace.

Stable:
  ICU 2.0

Definition at line 516 of file utypes.h.

#define U_SUCCESS | ( | x |  | ) | ((x)<=U_ZERO_ERROR)

Does the error code indicate success?

Stable:
  ICU 2.0

Definition at line 847 of file utypes.h.

Referenced by Formattable::getDate(), and ErrorCode::isSuccess().

#define U_TOOLUTIL_API U_IMPORT

Set to export library symbols from inside the toolutil library, and to import them from outside.

Stable:
  ICU 3.4

Definition at line 505 of file utypes.h.

#define U_USE_USRDATA 1

Internal:
  Do not use. This API is for internal use only.

Definition at line 237 of file utypes.h.

#define U_USRDATA_NAME "usrdt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER

Internal:
  Do not use. This API is for internal use only.

Definition at line 236 of file utypes.h.

## Typedef Documentation

typedef void* UClassID

UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ compilers.

Each class hierarchy which needs to implement polymorphic clone() or operator==() defines two methods, described in detail below. UClassID values can be compared using operator==(). Nothing else should be done with them.

  getDynamicClassID() is declared in the base class of the hierarchy as a pure virtual. Each concrete subclass implements it in the same way:

          class Base {
          public:
              virtual UClassID getDynamicClassID() const = 0;
          }

          class Derived {
          public:
              virtual UClassID getDynamicClassID() const
                { return Derived::getStaticClassID(); }
          }

Each concrete class implements getStaticClassID() as well, which allows clients to test for a specific type.

          class Derived {
          public:
              static UClassID U_EXPORT2 getStaticClassID();
          private:
              static char fgClassID;
          }

          // In Derived.cpp:
          UClassID Derived::getStaticClassID()
            { return (UClassID)&Derived::fgClassID; }
          char Derived::fgClassID = 0; // Value is irrelevant

Stable:
  ICU 2.0

Definition at line 365 of file utypes.h.

typedef double UDate

Date and Time data type.

This is a primitive data type that holds the date and time as the number of milliseconds since 1970-jan-01, 00:00 UTC. UTC leap seconds are ignored.

Stable:
  ICU 2.0

Definition at line 307 of file utypes.h.

## Enumeration Type Documentation

enum UErrorCode

Error code to replace exception handling, so that the code is compatible with all C++ compilers, and to use the same mechanism for C and C++.

  ICU functions that take a reference (C++) or a pointer (C) to a UErrorCode first test if(U_FAILURE(errorCode)) { return immediately; } so that in a chain of such functions the first one that sets an error code causes the following ones to not perform any operations.

  Error codes should be tested using U_FAILURE() and U_SUCCESS().

Stable:
  ICU 2.0

Enumerator:

  U_USING_FALLBACK_WARNING | A resource bundle lookup returned a fallback result (not an error).
  U_ERROR_WARNING_START | Start of information results (semantically successful).
  U_USING_DEFAULT_WARNING | A resource bundle lookup returned a result from the root locale (not an error).
  U_SAFECLONE_ALLOCATED_WARNING | A SafeClone operation required allocating memory (informational only).
  U_STATE_OLD_WARNING | ICU has to use compatibility layer to construct the service. Expect performance/memory usage degradation. Consider upgrading
  U_STRING_NOT_TERMINATED_WARNING | An output string could not be NUL-terminated because output length==destCapacity.
  U_SORT_KEY_TOO_SHORT_WARNING | Number of levels requested in getBound is higher than the number of levels in the sort key.
  U_AMBIGUOUS_ALIAS_WARNING | This converter alias can go to different converter implementations.
  U_DIFFERENT_UCA_VERSION | ucol_open encountered a mismatch between UCA version and collator image version, so the collator was constructed from rules. No impact to further function
  U_PLUGIN_CHANGED_LEVEL_WARNING | A plugin caused a level change. May not be an error, but later plugins may not load.
  U_ERROR_WARNING_LIMIT | This must always be the last warning value to indicate the limit for UErrorCode warnings (last warning code +1).
  U_ZERO_ERROR | No error, no warning.
  U_ILLEGAL_ARGUMENT_ERROR | Start of codes indicating failure.
  U_MISSING_RESOURCE_ERROR | The requested resource cannot be found.
  U_INVALID_FORMAT_ERROR | Data format is not what is expected.
  U_FILE_ACCESS_ERROR | The requested file cannot be found.
  U_INTERNAL_PROGRAM_ERROR | Indicates a bug in the library code.
  U_MESSAGE_PARSE_ERROR | Unable to parse a message (message format).
  U_MEMORY_ALLOCATION_ERROR | Memory allocation error.
  U_INDEX_OUTOFBOUNDS_ERROR | Trying to access the index that is out of bounds.
  U_PARSE_ERROR | Equivalent to Java ParseException.
  U_INVALID_CHAR_FOUND | Character conversion: Unmappable input sequence. In other APIs: Invalid character.
  U_TRUNCATED_CHAR_FOUND | Character conversion: Incomplete input sequence.
  U_ILLEGAL_CHAR_FOUND | Character conversion: Illegal input sequence/combination of input units.
  U_INVALID_TABLE_FORMAT | Conversion table file found, but corrupted.
  U_INVALID_TABLE_FILE | Conversion table file not found.
  U_BUFFER_OVERFLOW_ERROR | A result would not fit in the supplied buffer.
  U_UNSUPPORTED_ERROR | Requested operation not supported in current context.
  U_RESOURCE_TYPE_MISMATCH | an operation is requested over a resource that does not support it
  U_ILLEGAL_ESCAPE_SEQUENCE | ISO-2022 illlegal escape sequence.
  U_UNSUPPORTED_ESCAPE_SEQUENCE | ISO-2022 unsupported escape sequence.
  U_NO_SPACE_AVAILABLE | No space available for in-buffer expansion for Arabic shaping.
  U_CE_NOT_FOUND_ERROR | Currently used only while setting variable top, but can be used generally.
  U_PRIMARY_TOO_LONG_ERROR | User tried to set variable top to a primary that is longer than two bytes.
  U_STATE_TOO_OLD_ERROR | ICU cannot construct a service from this state, as it is no longer supported.
  U_TOO_MANY_ALIASES_ERROR | There are too many aliases in the path to the requested resource. It is very possible that a circular alias definition has occured
  U_ENUM_OUT_OF_SYNC_ERROR | UEnumeration out of sync with underlying collection.
  U_INVARIANT_CONVERSION_ERROR | Unable to convert a UChar* string to char* with the invariant converter.
  U_INVALID_STATE_ERROR | Requested operation can not be completed with ICU in its current state.
  U_COLLATOR_VERSION_MISMATCH | Collator version is not compatible with the base version.
  U_USELESS_COLLATOR_ERROR | Collator is options only and no base is specified.
  U_NO_WRITE_PERMISSION | Attempt to modify read-only or constant data.
  U_STANDARD_ERROR_LIMIT | This must always be the last value to indicate the limit for standard errors.
  U_BAD_VARIABLE_DEFINITION | Missing '$' or duplicate variable name.
  U_PARSE_ERROR_START | Start of Transliterator errors.
  U_MALFORMED_RULE | Elements of a rule are misplaced.
  U_MALFORMED_SET | A UnicodeSet pattern is invalid.
  U_MALFORMED_SYMBOL_REFERENCE | UNUSED as of ICU 2.4.
  U_MALFORMED_UNICODE_ESCAPE | A Unicode escape pattern is invalid.
  U_MALFORMED_VARIABLE_DEFINITION | A variable definition is invalid.
  U_MALFORMED_VARIABLE_REFERENCE | A variable reference is invalid.
  U_MISMATCHED_SEGMENT_DELIMITERS | UNUSED as of ICU 2.4.
  U_MISPLACED_ANCHOR_START | A start anchor appears at an illegal position.
  U_MISPLACED_CURSOR_OFFSET | A cursor offset occurs at an illegal position.
  U_MISPLACED_QUANTIFIER | A quantifier appears after a segment close delimiter.
  U_MISSING_OPERATOR | A rule contains no operator.
  U_MISSING_SEGMENT_CLOSE | UNUSED as of ICU 2.4.
  U_MULTIPLE_ANTE_CONTEXTS | More than one ante context.
  U_MULTIPLE_CURSORS | More than one cursor.
  U_MULTIPLE_POST_CONTEXTS | More than one post context.
  U_TRAILING_BACKSLASH | A dangling backslash.
  U_UNDEFINED_SEGMENT_REFERENCE | A segment reference does not correspond to a defined segment.
  U_UNDEFINED_VARIABLE | A variable reference does not correspond to a defined variable.
  U_UNQUOTED_SPECIAL | A special character was not quoted or escaped.
  U_UNTERMINATED_QUOTE | A closing single quote is missing.
  U_RULE_MASK_ERROR | A rule is hidden by an earlier more general rule.
  U_MISPLACED_COMPOUND_FILTER | A compound filter is in an invalid location.
  U_MULTIPLE_COMPOUND_FILTERS | More than one compound filter.
  U_INVALID_RBT_SYNTAX | A "::id" rule was passed to the RuleBasedTransliterator parser.
  U_INVALID_PROPERTY_PATTERN | UNUSED as of ICU 2.4.
  U_MALFORMED_PRAGMA | A 'use' pragma is invlalid.
  U_UNCLOSED_SEGMENT | A closing ')' is missing.
  U_ILLEGAL_CHAR_IN_SEGMENT | UNUSED as of ICU 2.4.
  U_VARIABLE_RANGE_EXHAUSTED | Too many stand-ins generated for the given variable range.
  U_VARIABLE_RANGE_OVERLAP | The variable range overlaps characters used in rules.
  U_ILLEGAL_CHARACTER | A special character is outside its allowed context.
  U_INTERNAL_TRANSLITERATOR_ERROR | Internal transliterator system error.
  U_INVALID_ID | A "::id" rule specifies an unknown transliterator.
  U_INVALID_FUNCTION | A "&fn()" rule specifies an unknown transliterator.
  U_PARSE_ERROR_LIMIT | The limit for Transliterator errors.
  U_UNEXPECTED_TOKEN | Syntax error in format pattern.
  U_FMT_PARSE_ERROR_START | Start of format library errors.
  U_MULTIPLE_DECIMAL_SEPARATORS | More than one decimal separator in number pattern.
  U_MULTIPLE_DECIMAL_SEPERATORS | Typo: kept for backward compatibility. Use U_MULTIPLE_DECIMAL_SEPARATORS
  U_MULTIPLE_EXPONENTIAL_SYMBOLS | More than one exponent symbol in number pattern.
  U_MALFORMED_EXPONENTIAL_PATTERN | Grouping symbol in exponent pattern.
  U_MULTIPLE_PERCENT_SYMBOLS | More than one percent symbol in number pattern.
  U_MULTIPLE_PERMILL_SYMBOLS | More than one permill symbol in number pattern.
  U_MULTIPLE_PAD_SPECIFIERS | More than one pad symbol in number pattern.
  U_PATTERN_SYNTAX_ERROR | Syntax error in format pattern.
  U_ILLEGAL_PAD_POSITION | Pad symbol misplaced in number pattern.
  U_UNMATCHED_BRACES | Braces do not match in message pattern.
  U_UNSUPPORTED_PROPERTY | UNUSED as of ICU 2.4.
  U_UNSUPPORTED_ATTRIBUTE | UNUSED as of ICU 2.4.
  U_ARGUMENT_TYPE_MISMATCH | Argument name and argument index mismatch in MessageFormat functions.
  U_DUPLICATE_KEYWORD | Duplicate keyword in PluralFormat.
  U_UNDEFINED_KEYWORD | Undefined Plural keyword.
  U_DEFAULT_KEYWORD_MISSING | Missing DEFAULT rule in plural rules.
  U_DECIMAL_NUMBER_SYNTAX_ERROR | Decimal number syntax error.
  U_FMT_PARSE_ERROR_LIMIT | The limit for format library errors.
  U_BRK_INTERNAL_ERROR | An internal error (bug) was detected.
  U_BRK_ERROR_START | Start of codes indicating Break Iterator failures.
  U_BRK_HEX_DIGITS_EXPECTED | Hex digits expected as part of a escaped char in a rule.
  U_BRK_SEMICOLON_EXPECTED | Missing ';' at the end of a RBBI rule.
  U_BRK_RULE_SYNTAX | Syntax error in RBBI rule.
  U_BRK_UNCLOSED_SET | UnicodeSet witing an RBBI rule missing a closing ']'.
  U_BRK_ASSIGN_ERROR | Syntax error in RBBI rule assignment statement.
  U_BRK_VARIABLE_REDFINITION | RBBI rule $Variable redefined.
  U_BRK_MISMATCHED_PAREN | Mis-matched parentheses in an RBBI rule.
  U_BRK_NEW_LINE_IN_QUOTED_STRING | Missing closing quote in an RBBI rule.
  U_BRK_UNDEFINED_VARIABLE | Use of an undefined $Variable in an RBBI rule.
  U_BRK_INIT_ERROR | Initialization failure. Probable missing ICU Data.
  U_BRK_RULE_EMPTY_SET | Rule contains an empty Unicode Set.
  U_BRK_UNRECOGNIZED_OPTION | !!option in RBBI rules not recognized.
  U_BRK_MALFORMED_RULE_TAG | The {nnn} tag on a rule is mal formed.
  U_BRK_ERROR_LIMIT | This must always be the last value to indicate the limit for Break Iterator failures.
  U_REGEX_INTERNAL_ERROR | An internal error (bug) was detected.
  U_REGEX_ERROR_START | Start of codes indicating Regexp failures.
  U_REGEX_RULE_SYNTAX | Syntax error in regexp pattern.
  U_REGEX_INVALID_STATE | RegexMatcher in invalid state for requested operation.
  U_REGEX_BAD_ESCAPE_SEQUENCE | Unrecognized backslash escape sequence in pattern.
  U_REGEX_PROPERTY_SYNTAX | Incorrect Unicode property.
  U_REGEX_UNIMPLEMENTED | Use of regexp feature that is not yet implemented.
  U_REGEX_MISMATCHED_PAREN | Incorrectly nested parentheses in regexp pattern.
  U_REGEX_NUMBER_TOO_BIG | Decimal number is too large.
  U_REGEX_BAD_INTERVAL | Error in {min,max} interval.
  U_REGEX_MAX_LT_MIN | In {min,max}, max is less than min.
  U_REGEX_INVALID_BACK_REF | Back-reference to a non-existent capture group.
  U_REGEX_INVALID_FLAG | Invalid value for match mode flags.
  U_REGEX_LOOK_BEHIND_LIMIT | Look-Behind pattern matches must have a bounded maximum length.
  U_REGEX_SET_CONTAINS_STRING | Regexps cannot have UnicodeSets containing strings.
  U_REGEX_OCTAL_TOO_BIG | Octal character constants must be <= 0377.
  U_REGEX_MISSING_CLOSE_BRACKET | Missing closing bracket on a bracket expression.
  U_REGEX_INVALID_RANGE | In a character range [x-y], x is greater than y.
  U_REGEX_STACK_OVERFLOW | Regular expression backtrack stack overflow.
  U_REGEX_TIME_OUT | Maximum allowed match time exceeded.
  U_REGEX_STOPPED_BY_CALLER | Matching operation aborted by user callback fn.
  U_REGEX_ERROR_LIMIT | This must always be the last value to indicate the limit for regexp errors.
  U_PLUGIN_ERROR_START | Start of codes indicating plugin failures.
  U_PLUGIN_TOO_HIGH | The plugin's level is too high to be loaded right now.
  U_PLUGIN_DIDNT_SET_LEVEL | The plugin didn't call uplug_setPlugLevel in response to a QUERY.
  U_PLUGIN_ERROR_LIMIT | This must always be the last value to indicate the limit for plugin errors.
  U_ERROR_LIMIT | This must always be the last value to indicate the limit for UErrorCode (last error code +1).

Definition at line 619 of file utypes.h.

## Function Documentation

const char* u_errorName | ( | UErrorCode | code | ) |

Return a string for a UErrorCode value.

The string will be the same as the name of the error code constant in the UErrorCode enum above.

Stable:
  ICU 2.0

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines