ICU 78.2 78.2

Namespaces | Macros | Typedefs | Enumerations | Functions
ucnv.h File Reference

C API: Character conversion. More...

`#include "unicode/ucnv_err.h"`
`#include "unicode/uenum.h"`
`#include "unicode/localpointer.h"`

Go to the source code of this file.

## Namespaces
| icu
| File coll.h.

## Macros
#define | UCNV_MAX_CONVERTER_NAME_LENGTH 60
| Maximum length of a converter name including the terminating NULL. More...
#define | UCNV_MAX_FULL_FILE_NAME_LENGTH (600+UCNV_MAX_CONVERTER_NAME_LENGTH)
| Maximum length of a converter name including path and terminating NULL. More...
#define | UCNV_SI 0x0F
| Shift in for EBDCDIC_STATEFUL and iso2022 states. More...
#define | UCNV_SO 0x0E
| Shift out for EBDCDIC_STATEFUL and iso2022 states. More...
#define | UCNV_OPTION_SEP_CHAR ','
| Character that separates converter names from options and options from each other. More...
#define | UCNV_OPTION_SEP_STRING ","
| String version of UCNV_OPTION_SEP_CHAR. More...
#define | UCNV_VALUE_SEP_CHAR '='
| Character that separates a converter option from its value. More...
#define | UCNV_VALUE_SEP_STRING "="
| String version of UCNV_VALUE_SEP_CHAR. More...
#define | UCNV_LOCALE_OPTION_STRING ",locale="
| Converter option for specifying a locale. More...
#define | UCNV_VERSION_OPTION_STRING ",version="
| Converter option for specifying a version selector (0..9) for some converters. More...
#define | UCNV_SWAP_LFNL_OPTION_STRING ",swaplfnl"
| Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages. More...
#define | U_CNV_SAFECLONE_BUFFERSIZE 1024
| Definition of a buffer size that is designed to be large enough for converters to be cloned with ucnv_safeClone(). More...
#define | UCNV_GET_MAX_BYTES_FOR_STRING(length, maxCharSize) (((int32_t)(length)+10)*(int32_t)(maxCharSize))
| Calculates the size of a buffer for conversion from Unicode to a charset. More...

## Typedefs
typedef void(* | UConverterToUCallback) (const void *context, UConverterToUnicodeArgs *args, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *pErrorCode)
| Function pointer for error callback in the codepage to unicode direction. More...
typedef void(* | UConverterFromUCallback) (const void *context, UConverterFromUnicodeArgs *args, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *pErrorCode)
| Function pointer for error callback in the unicode to codepage direction. More...
typedef enum UConverterUnicodeSet | UConverterUnicodeSet
| Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet(). More...

## Enumerations
enum | UConverterType { UCNV_UNSUPPORTED_CONVERTER = -1 , UCNV_SBCS = 0 , UCNV_DBCS = 1 , UCNV_MBCS = 2 , UCNV_LATIN_1 = 3 , UCNV_UTF8 = 4 , UCNV_UTF16_BigEndian = 5 , UCNV_UTF16_LittleEndian = 6 , UCNV_UTF32_BigEndian = 7 , UCNV_UTF32_LittleEndian = 8 , UCNV_EBCDIC_STATEFUL = 9 , UCNV_ISO_2022 = 10 , UCNV_LMBCS_1 = 11 , UCNV_LMBCS_2 , UCNV_LMBCS_3 , UCNV_LMBCS_4 , UCNV_LMBCS_5 , UCNV_LMBCS_6 , UCNV_LMBCS_8 , UCNV_LMBCS_11 , UCNV_LMBCS_16 , UCNV_LMBCS_17 , UCNV_LMBCS_18 , UCNV_LMBCS_19 , UCNV_LMBCS_LAST = UCNV_LMBCS_19 , UCNV_HZ , UCNV_SCSU , UCNV_ISCII , UCNV_US_ASCII , UCNV_UTF7 , UCNV_BOCU1 , UCNV_UTF16 , UCNV_UTF32 , UCNV_CESU8 , UCNV_IMAP_MAILBOX , UCNV_COMPOUND_TEXT , UCNV_NUMBER_OF_SUPPORTED_CONVERTER_TYPES }
| Enum for specifying basic types of converters. More...
enum | UConverterPlatform { UCNV_UNKNOWN = -1 , UCNV_IBM = 0 }
| Enum for specifying which platform a converter ID refers to. More...
enum | UConverterUnicodeSet { UCNV_ROUNDTRIP_SET , UCNV_ROUNDTRIP_AND_FALLBACK_SET , UCNV_SET_COUNT }
| Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet(). More...

## Functions
U_CAPI int | ucnv_compareNames (const char *name1, const char *name2)
| Do a fuzzy compare of two converter/alias names. More...
U_CAPI UConverter * | ucnv_open (const char *converterName, UErrorCode *err)
| Creates a UConverter object with the name of a coded character set specified as a C string. More...
U_CAPI UConverter * | ucnv_openU (const UChar *name, UErrorCode *err)
| Creates a Unicode converter with the names specified as unicode string. More...
U_CAPI UConverter * | ucnv_openCCSID (int32_t codepage, UConverterPlatform platform, UErrorCode *err)
| Creates a UConverter object from a CCSID number and platform pair. More...
U_CAPI UConverter * | ucnv_openPackage (const char *packageName, const char *converterName, UErrorCode *err)
U_CAPI UConverter * | ucnv_clone (const UConverter *cnv, UErrorCode *status)
| Thread safe converter cloning operation. More...
UConverter * | ucnv_safeClone (const UConverter *cnv, void *stackBuffer, int32_t *pBufferSize, UErrorCode *status)
| Thread safe converter cloning operation. More...
U_CAPI void | ucnv_close (UConverter *converter)
| Deletes the unicode converter and releases resources associated with just this instance. More...
U_CAPI void | ucnv_getSubstChars (const UConverter *converter, char *subChars, int8_t *len, UErrorCode *err)
| Fills in the output parameter, subChars, with the substitution characters as multiple bytes. More...
U_CAPI void | ucnv_setSubstChars (UConverter *converter, const char *subChars, int8_t len, UErrorCode *err)
| Sets the substitution chars when converting from unicode to a codepage. More...
U_CAPI void | ucnv_setSubstString (UConverter *cnv, const UChar *s, int32_t length, UErrorCode *err)
| Set a substitution string for converting from Unicode to a charset. More...
U_CAPI void | ucnv_getInvalidChars (const UConverter *converter, char *errBytes, int8_t *len, UErrorCode *err)
| Fills in the output parameter, errBytes, with the error characters from the last failing conversion. More...
U_CAPI void | ucnv_getInvalidUChars (const UConverter *converter, UChar *errUChars, int8_t *len, UErrorCode *err)
| Fills in the output parameter, errChars, with the error characters from the last failing conversion. More...
U_CAPI void | ucnv_reset (UConverter *converter)
| Resets the state of a converter to the default state. More...
U_CAPI void | ucnv_resetToUnicode (UConverter *converter)
| Resets the to-Unicode part of a converter state to the default state. More...
U_CAPI void | ucnv_resetFromUnicode (UConverter *converter)
| Resets the from-Unicode part of a converter state to the default state. More...
U_CAPI int8_t | ucnv_getMaxCharSize (const UConverter *converter)
| Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this converter. More...
U_CAPI int8_t | ucnv_getMinCharSize (const UConverter *converter)
| Returns the minimum byte length (per codepoint) for characters in this codepage. More...
U_CAPI int32_t | ucnv_getDisplayName (const UConverter *converter, const char *displayLocale, UChar *displayName, int32_t displayNameCapacity, UErrorCode *err)
| Returns the display name of the converter passed in based on the Locale passed in. More...
U_CAPI const char * | ucnv_getName (const UConverter *converter, UErrorCode *err)
| Gets the internal, canonical name of the converter (zero-terminated). More...
U_CAPI int32_t | ucnv_getCCSID (const UConverter *converter, UErrorCode *err)
| Gets a codepage number associated with the converter. More...
U_CAPI UConverterPlatform | ucnv_getPlatform (const UConverter *converter, UErrorCode *err)
| Gets a codepage platform associated with the converter. More...
U_CAPI UConverterType | ucnv_getType (const UConverter *converter)
| Gets the type of the converter e.g. More...
U_CAPI void | ucnv_getStarters (const UConverter *converter, UBool starters[256], UErrorCode *err)
| Gets the "starter" (lead) bytes for converters of type MBCS. More...
U_CAPI void | ucnv_getUnicodeSet (const UConverter *cnv, USet *setFillIn, UConverterUnicodeSet whichSet, UErrorCode *pErrorCode)
| Returns the set of Unicode code points that can be converted by an ICU converter. More...
U_CAPI void | ucnv_getToUCallBack (const UConverter *converter, UConverterToUCallback *action, const void **context)
| Gets the current callback function used by the converter when an illegal or invalid codepage sequence is found. More...
U_CAPI void | ucnv_getFromUCallBack (const UConverter *converter, UConverterFromUCallback *action, const void **context)
| Gets the current callback function used by the converter when illegal or invalid Unicode sequence is found. More...
U_CAPI void | ucnv_setToUCallBack (UConverter *converter, UConverterToUCallback newAction, const void *newContext, UConverterToUCallback *oldAction, const void **oldContext, UErrorCode *err)
| Changes the callback function used by the converter when an illegal or invalid sequence is found. More...
U_CAPI void | ucnv_setFromUCallBack (UConverter *converter, UConverterFromUCallback newAction, const void *newContext, UConverterFromUCallback *oldAction, const void **oldContext, UErrorCode *err)
| Changes the current callback function used by the converter when an illegal or invalid sequence is found. More...
U_CAPI void | ucnv_fromUnicode (UConverter *converter, char **target, const char *targetLimit, const UChar **source, const UChar *sourceLimit, int32_t *offsets, UBool flush, UErrorCode *err)
| Converts an array of unicode characters to an array of codepage characters. More...
U_CAPI void | ucnv_toUnicode (UConverter *converter, UChar **target, const UChar *targetLimit, const char **source, const char *sourceLimit, int32_t *offsets, UBool flush, UErrorCode *err)
| Converts a buffer of codepage bytes into an array of unicode UChars characters. More...
U_CAPI int32_t | ucnv_fromUChars (UConverter *cnv, char *dest, int32_t destCapacity, const UChar *src, int32_t srcLength, UErrorCode *pErrorCode)
| Convert the Unicode string into a codepage string using an existing UConverter. More...
U_CAPI int32_t | ucnv_toUChars (UConverter *cnv, UChar *dest, int32_t destCapacity, const char *src, int32_t srcLength, UErrorCode *pErrorCode)
| Convert the codepage string into a Unicode string using an existing UConverter. More...
U_CAPI UChar32 | ucnv_getNextUChar (UConverter *converter, const char **source, const char *sourceLimit, UErrorCode *err)
| Convert a codepage buffer into Unicode one character at a time. More...
U_CAPI void | ucnv_convertEx (UConverter *targetCnv, UConverter *sourceCnv, char **target, const char *targetLimit, const char **source, const char *sourceLimit, UChar *pivotStart, UChar **pivotSource, UChar **pivotTarget, const UChar *pivotLimit, UBool reset, UBool flush, UErrorCode *pErrorCode)
| Convert from one external charset to another using two existing UConverters. More...
U_CAPI int32_t | ucnv_convert (const char *toConverterName, const char *fromConverterName, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, UErrorCode *pErrorCode)
| Convert from one external charset to another. More...
U_CAPI int32_t | ucnv_toAlgorithmic (UConverterType algorithmicType, UConverter *cnv, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, UErrorCode *pErrorCode)
| Convert from one external charset to another. More...
U_CAPI int32_t | ucnv_fromAlgorithmic (UConverter *cnv, UConverterType algorithmicType, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, UErrorCode *pErrorCode)
| Convert from one external charset to another. More...
U_CAPI int32_t | ucnv_flushCache (void)
| Frees up memory occupied by unused, cached converter shared data. More...
U_CAPI int32_t | ucnv_countAvailable (void)
| Returns the number of available converters, as per the alias file. More...
U_CAPI const char * | ucnv_getAvailableName (int32_t n)
| Gets the canonical converter name of the specified converter from a list of all available converters contained in the alias file. More...
U_CAPI UEnumeration * | ucnv_openAllNames (UErrorCode *pErrorCode)
| Returns a UEnumeration to enumerate all of the canonical converter names, as per the alias file, regardless of the ability to open each converter. More...
U_CAPI uint16_t | ucnv_countAliases (const char *alias, UErrorCode *pErrorCode)
| Gives the number of aliases for a given converter or alias name. More...
U_CAPI const char * | ucnv_getAlias (const char *alias, uint16_t n, UErrorCode *pErrorCode)
| Gives the name of the alias at given index of alias list. More...
U_CAPI void | ucnv_getAliases (const char *alias, const char **aliases, UErrorCode *pErrorCode)
| Fill-up the list of alias names for the given alias. More...
U_CAPI UEnumeration * | ucnv_openStandardNames (const char *convName, const char *standard, UErrorCode *pErrorCode)
| Return a new UEnumeration object for enumerating all the alias names for a given converter that are recognized by a standard. More...
U_CAPI uint16_t | ucnv_countStandards (void)
| Gives the number of standards associated to converter names. More...
U_CAPI const char * | ucnv_getStandard (uint16_t n, UErrorCode *pErrorCode)
| Gives the name of the standard at given index of standard list. More...
U_CAPI const char * | ucnv_getStandardName (const char *name, const char *standard, UErrorCode *pErrorCode)
| Returns a standard name for a given converter name. More...
U_CAPI const char * | ucnv_getCanonicalName (const char *alias, const char *standard, UErrorCode *pErrorCode)
| This function will return the internal canonical converter name of the tagged alias. More...
U_CAPI const char * | ucnv_getDefaultName (void)
| Returns the current default converter name. More...
U_CAPI void | ucnv_setDefaultName (const char *name)
| This function is not thread safe. More...
U_CAPI void | ucnv_fixFileSeparator (const UConverter *cnv, UChar *source, int32_t sourceLen)
| Fixes the backslash character mismapping. More...
U_CAPI UBool | ucnv_isAmbiguous (const UConverter *cnv)
| Determines if the converter contains ambiguous mappings of the same character or not. More...
U_CAPI void | ucnv_setFallback (UConverter *cnv, UBool usesFallback)
| Sets the converter to use fallback mappings or not. More...
U_CAPI UBool | ucnv_usesFallback (const UConverter *cnv)
| Determines if the converter uses fallback mappings or not. More...
U_CAPI const char * | ucnv_detectUnicodeSignature (const char *source, int32_t sourceLength, int32_t *signatureLength, UErrorCode *pErrorCode)
| Detects Unicode signature byte sequences at the start of the byte stream and returns the charset name of the indicated Unicode charset. More...
U_CAPI int32_t | ucnv_fromUCountPending (const UConverter *cnv, UErrorCode *status)
| Returns the number of UChars held in the converter's internal state because more input is needed for completing the conversion. More...
U_CAPI int32_t | ucnv_toUCountPending (const UConverter *cnv, UErrorCode *status)
| Returns the number of chars held in the converter's internal state because more input is needed for completing the conversion. More...
U_CAPI UBool | ucnv_isFixedWidth (UConverter *cnv, UErrorCode *status)
| Returns whether or not the charset of the converter has a fixed number of bytes per charset character. More...

## Detailed Description

C API: Character conversion.

## Character Conversion C API

This API is used to convert codepage or character encoded data to and from UTF-16. You can open a converter with ucnv_open(). With that converter, you can get its properties, set options, convert your data and close the converter.

Since many software programs recognize different converter names for different types of converters, there are other functions in this API to iterate over the converter aliases. The functions ucnv_getAvailableName(), ucnv_getAlias() and ucnv_getStandardName() are some of the more frequently used alias functions to get this information.

When a converter encounters an illegal, irregular, invalid or unmappable character its default behavior is to use a substitution character to replace the bad byte sequence. This behavior can be changed by using ucnv_setFromUCallBack() or ucnv_setToUCallBack() on the converter. The header ucnv_err.h defines many other callback actions that can be used instead of a character substitution.

More information about this API can be found in our User Guide.

Definition in file ucnv.h.

## Macro Definition Documentation

## ◆ U_CNV_SAFECLONE_BUFFERSIZE

#define U_CNV_SAFECLONE_BUFFERSIZE 1024

Definition of a buffer size that is designed to be large enough for converters to be cloned with ucnv_safeClone().

Deprecated:
  ICU 52. Do not rely on ucnv_safeClone() cloning into any provided buffer.

Definition at line 566 of file ucnv.h.

## ◆ UCNV_GET_MAX_BYTES_FOR_STRING

#define UCNV_GET_MAX_BYTES_FOR_STRING | ( |  | length,
|  |  | maxCharSize
| ) |  | (((int32_t)(length)+10)*(int32_t)(maxCharSize))

Calculates the size of a buffer for conversion from Unicode to a charset.

The calculated size is guaranteed to be sufficient for this conversion.

It takes into account initial and final non-character bytes that are output by some converters. It does not take into account callbacks which output more than one charset character sequence per call, like escape callbacks. The default (substitution) callback only outputs one charset character sequence.

Parameters

  length | Number of UChars to be converted.
  maxCharSize | Return value from ucnv_getMaxCharSize() for the converter that will be used.

Returns
  Size of a buffer that will be large enough to hold the output bytes of converting length UChars with the converter that returned the maxCharSize.

See also
  ucnv_getMaxCharSize

Stable:
  ICU 2.8

Definition at line 826 of file ucnv.h.

## ◆ UCNV_LOCALE_OPTION_STRING

#define UCNV_LOCALE_OPTION_STRING ",locale="

Converter option for specifying a locale.

For example, ucnv_open("SCSU,locale=ja", &errorCode); See convrtrs.txt.

See also
  ucnv_open

Stable:
  ICU 2.0

Definition at line 271 of file ucnv.h.

## ◆ UCNV_MAX_CONVERTER_NAME_LENGTH

#define UCNV_MAX_CONVERTER_NAME_LENGTH 60

Maximum length of a converter name including the terminating NULL.

Stable:
  ICU 2.0

Definition at line 79 of file ucnv.h.

## ◆ UCNV_MAX_FULL_FILE_NAME_LENGTH

#define UCNV_MAX_FULL_FILE_NAME_LENGTH (600+UCNV_MAX_CONVERTER_NAME_LENGTH)

Maximum length of a converter name including path and terminating NULL.

Stable:
  ICU 2.0

Definition at line 81 of file ucnv.h.

## ◆ UCNV_OPTION_SEP_CHAR

#define UCNV_OPTION_SEP_CHAR ','

Character that separates converter names from options and options from each other.

See also
  ucnv_open

Stable:
  ICU 2.0

Definition at line 240 of file ucnv.h.

## ◆ UCNV_OPTION_SEP_STRING

#define UCNV_OPTION_SEP_STRING ","

String version of UCNV_OPTION_SEP_CHAR.

See also
  ucnv_open

Stable:
  ICU 2.0

Definition at line 247 of file ucnv.h.

## ◆ UCNV_SI

#define UCNV_SI 0x0F

Shift in for EBDCDIC_STATEFUL and iso2022 states.

Stable:
  ICU 2.0

Definition at line 84 of file ucnv.h.

## ◆ UCNV_SO

#define UCNV_SO 0x0E

Shift out for EBDCDIC_STATEFUL and iso2022 states.

Stable:
  ICU 2.0

Definition at line 86 of file ucnv.h.

## ◆ UCNV_SWAP_LFNL_OPTION_STRING

#define UCNV_SWAP_LFNL_OPTION_STRING ",swaplfnl"

Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages.

Swaps Unicode mappings for EBCDIC LF and NL codes, as used on S/390 (z/OS) Unix System Services (Open Edition). For example, ucnv_open("ibm-1047,swaplfnl", &errorCode); See convrtrs.txt.

See also
  ucnv_open

Stable:
  ICU 2.4

Definition at line 296 of file ucnv.h.

## ◆ UCNV_VALUE_SEP_CHAR

#define UCNV_VALUE_SEP_CHAR '='

Character that separates a converter option from its value.

See also
  ucnv_open

Stable:
  ICU 2.0

Definition at line 254 of file ucnv.h.

## ◆ UCNV_VALUE_SEP_STRING

#define UCNV_VALUE_SEP_STRING "="

String version of UCNV_VALUE_SEP_CHAR.

See also
  ucnv_open

Stable:
  ICU 2.0

Definition at line 261 of file ucnv.h.

## ◆ UCNV_VERSION_OPTION_STRING

#define UCNV_VERSION_OPTION_STRING ",version="

Converter option for specifying a version selector (0..9) for some converters.

For example,

ucnv_open("UTF-7,version=1", &errorCode);
ucnv_open
U_CAPI UConverter * ucnv_open(const char *converterName, UErrorCode *err)
Creates a UConverter object with the name of a coded character set specified as a C string.

See convrtrs.txt.

See also
  ucnv_open

Stable:
  ICU 2.4

Definition at line 284 of file ucnv.h.

## Typedef Documentation

## ◆ UConverterFromUCallback

typedef void( * UConverterFromUCallback) (const void *context, UConverterFromUnicodeArgs *args, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *pErrorCode)

Function pointer for error callback in the unicode to codepage direction.

Called when an error has occurred in conversion from unicode, or on open/close of the callback (see reason).

Parameters

  context | Pointer to the callback's private data
  args | Information about the conversion in progress
  codeUnits | Points to 'length' UChars of the concerned Unicode sequence
  length | Size (in bytes) of the concerned codepage sequence
  codePoint | Single UChar32 (UTF-32) containing the concerend Unicode codepoint.
  reason | Defines the reason the callback was invoked
  pErrorCode | ICU error code in/out parameter. For converter callback functions, set to a conversion error before the call, and the callback may reset it to U_ZERO_ERROR.

See also
  ucnv_setFromUCallBack

Stable:
  ICU 2.0

Definition at line 224 of file ucnv.h.

## ◆ UConverterToUCallback

typedef void( * UConverterToUCallback) (const void *context, UConverterToUnicodeArgs *args, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *pErrorCode)

Function pointer for error callback in the codepage to unicode direction.

Called when an error has occurred in conversion to unicode, or on open/close of the callback (see reason).

Parameters

  context | Pointer to the callback's private data
  args | Information about the conversion in progress
  codeUnits | Points to 'length' bytes of the concerned codepage sequence
  length | Size (in bytes) of the concerned codepage sequence
  reason | Defines the reason the callback was invoked
  pErrorCode | ICU error code in/out parameter. For converter callback functions, set to a conversion error before the call, and the callback may reset it to U_ZERO_ERROR.

See also
  ucnv_setToUCallBack
  UConverterToUnicodeArgs

Stable:
  ICU 2.0

Definition at line 201 of file ucnv.h.

## ◆ UConverterUnicodeSet

typedef enum UConverterUnicodeSet UConverterUnicodeSet

Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet().

See also
  ucnv_getUnicodeSet

Stable:
  ICU 2.6

## Enumeration Type Documentation

## ◆ UConverterPlatform

enum UConverterPlatform

Enum for specifying which platform a converter ID refers to.

The use of platform/CCSID is not recommended. See ucnv_openCCSID().

See also
  ucnv_getPlatform
  ucnv_openCCSID
  ucnv_getCCSID

Stable:
  ICU 2.0

Definition at line 181 of file ucnv.h.

## ◆ UConverterType

enum UConverterType

Enum for specifying basic types of converters.

See also
  ucnv_getType

Stable:
  ICU 2.0

Enumerator
UCNV_UNSUPPORTED_CONVERTER | Stable: ICU 2.0
UCNV_SBCS | Stable: ICU 2.0
UCNV_DBCS | Stable: ICU 2.0
UCNV_MBCS | Stable: ICU 2.0
UCNV_LATIN_1 | Stable: ICU 2.0
UCNV_UTF8 | Stable: ICU 2.0
UCNV_UTF16_BigEndian | Stable: ICU 2.0
UCNV_UTF16_LittleEndian | Stable: ICU 2.0
UCNV_UTF32_BigEndian | Stable: ICU 2.0
UCNV_UTF32_LittleEndian | Stable: ICU 2.0
UCNV_EBCDIC_STATEFUL | Stable: ICU 2.0
UCNV_ISO_2022 | Stable: ICU 2.0
UCNV_LMBCS_1 | Stable: ICU 2.0
UCNV_LMBCS_2 | Stable: ICU 2.0
UCNV_LMBCS_3 | Stable: ICU 2.0
UCNV_LMBCS_4 | Stable: ICU 2.0
UCNV_LMBCS_5 | Stable: ICU 2.0
UCNV_LMBCS_6 | Stable: ICU 2.0
UCNV_LMBCS_8 | Stable: ICU 2.0
UCNV_LMBCS_11 | Stable: ICU 2.0
UCNV_LMBCS_16 | Stable: ICU 2.0
UCNV_LMBCS_17 | Stable: ICU 2.0
UCNV_LMBCS_18 | Stable: ICU 2.0
UCNV_LMBCS_19 | Stable: ICU 2.0
UCNV_LMBCS_LAST | Stable: ICU 2.0
UCNV_HZ | Stable: ICU 2.0
UCNV_SCSU | Stable: ICU 2.0
UCNV_ISCII | Stable: ICU 2.0
UCNV_US_ASCII | Stable: ICU 2.0
UCNV_UTF7 | Stable: ICU 2.0
UCNV_BOCU1 | Stable: ICU 2.2
UCNV_UTF16 | Stable: ICU 2.2
UCNV_UTF32 | Stable: ICU 2.2
UCNV_CESU8 | Stable: ICU 2.2
UCNV_IMAP_MAILBOX | Stable: ICU 2.4
UCNV_COMPOUND_TEXT | Stable: ICU 4.8

Definition at line 93 of file ucnv.h.

## ◆ UConverterUnicodeSet

enum UConverterUnicodeSet

Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet().

See also
  ucnv_getUnicodeSet

Stable:
  ICU 2.6

Enumerator
UCNV_ROUNDTRIP_SET | Select the set of roundtrippable Unicode code points. Stable: ICU 2.6
UCNV_ROUNDTRIP_AND_FALLBACK_SET | Select the set of Unicode code points with roundtrip or fallback mappings. Stable: ICU 4.0
UCNV_SET_COUNT | Number of UConverterUnicodeSet selectors. Deprecated: ICU 58 The numeric value may change over time, see ICU ticket #12420.

Definition at line 952 of file ucnv.h.

## Function Documentation

## ◆ ucnv_clone()

U_CAPI UConverter* ucnv_clone | ( | const UConverter * | cnv,
|  | UErrorCode * | status
| ) |  |

Thread safe converter cloning operation.

You must ucnv_close() the clone.

Parameters

  cnv | converter to be cloned
  status | to indicate whether the operation went on smoothly or there were errors

Returns
  pointer to the new clone

Stable:
  ICU 71

## ◆ ucnv_close()

U_CAPI void ucnv_close | ( | UConverter * | converter | ) |

Deletes the unicode converter and releases resources associated with just this instance.

Does not free up shared converter tables.

Parameters

  converter | the converter object to be deleted

See also
  ucnv_open
  ucnv_openU
  ucnv_openCCSID

Stable:
  ICU 2.0

## ◆ ucnv_compareNames()

U_CAPI int ucnv_compareNames | ( | const char * | name1,
|  | const char * | name2
| ) |  |

Do a fuzzy compare of two converter/alias names.

The comparison is case-insensitive, ignores leading zeroes if they are not followed by further digits, and ignores all but letters and digits. Thus the strings "UTF-8", "utf_8", "u*T@f08" and "Utf 8" are exactly equivalent. See section 1.4, Charset Alias Matching in Unicode Technical Standard #22 at http://www.unicode.org/reports/tr22/

Parameters

  name1 | a converter name or alias, zero-terminated
  name2 | a converter name or alias, zero-terminated

Returns
  0 if the names match, or a negative value if the name1 lexically precedes name2, or a positive value if the name1 lexically follows name2.

Stable:
  ICU 2.0

## ◆ ucnv_convert()

U_CAPI int32_t ucnv_convert | ( | const char * | toConverterName,
|  | const char * | fromConverterName,
|  | char * | target,
|  | int32_t | targetCapacity,
|  | const char * | source,
|  | int32_t | sourceLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert from one external charset to another.

Internally, two converters are opened according to the name arguments, then the text is converted to and from the 16-bit Unicode "pivot" using ucnv_convertEx(), then the converters are closed again.

This is a convenience function, not an efficient way to convert a lot of text: ucnv_convert()

- takes charset names, not converter objects, so that
  - two converters are opened for each call
  - only single-string conversion is possible, not streaming operation
- does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed
- allows NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if sourceLength==-1, see parameters)
- terminate with a NUL on output (only a single NUL byte, not useful for charsets with multi-byte NULs), or set U_STRING_NOT_TERMINATED_WARNING if the output exactly fills the target buffer
- a pivot buffer is provided internally

The function returns when one of the following is true:

- the entire source text has been converted successfully to the target buffer and either the target buffer is terminated with a single NUL byte or the error code is set to U_STRING_NOT_TERMINATED_WARNING
- a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR) and the full output string length is returned ("preflighting")
- a conversion error occurred (other U_FAILURE(), see description of pErrorCode)

Parameters

  toConverterName | The name of the converter that is used to convert from the UTF-16 pivot buffer to the target.
  fromConverterName | The name of the converter that is used to convert from the source to the UTF-16 pivot buffer.
  target | Pointer to the output buffer.
  targetCapacity | Capacity of the target, in bytes.
  source | Pointer to the input buffer.
  sourceLength | Length of the input text, in bytes, or -1 for NUL-terminated input.
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.

See also
  ucnv_convertEx
  ucnv_fromAlgorithmic
  ucnv_toAlgorithmic
  ucnv_fromUnicode
  ucnv_toUnicode
  ucnv_fromUChars
  ucnv_toUChars
  ucnv_getNextUChar

Stable:
  ICU 2.0

## ◆ ucnv_convertEx()

U_CAPI void ucnv_convertEx | ( | UConverter * | targetCnv,
|  | UConverter * | sourceCnv,
|  | char ** | target,
|  | const char * | targetLimit,
|  | const char ** | source,
|  | const char * | sourceLimit,
|  | UChar * | pivotStart,
|  | UChar ** | pivotSource,
|  | UChar ** | pivotTarget,
|  | const UChar * | pivotLimit,
|  | UBool | reset,
|  | UBool | flush,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert from one external charset to another using two existing UConverters.

Internally, two conversions - ucnv_toUnicode() and ucnv_fromUnicode() - are used, "pivoting" through 16-bit Unicode.

Important: For streaming conversion (multiple function calls for successive parts of a text stream), the caller must provide a pivot buffer explicitly, and must preserve the pivot buffer and associated pointers from one call to another. (The buffer may be moved if its contents and the relative pointer positions are preserved.)

There is a similar function, ucnv_convert(), which has the following limitations:

- it takes charset names, not converter objects, so that
  - two converters are opened for each call
  - only single-string conversion is possible, not streaming operation
- it does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed

By contrast, ucnv_convertEx()

- takes UConverter parameters instead of charset names
- fully exposes the pivot buffer for streaming conversion and complete error handling

ucnv_convertEx() also provides further convenience:

- an option to reset the converters at the beginning (if reset==true, see parameters; also sets *pivotTarget=*pivotSource=pivotStart)
- allow NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if sourceLimit==NULL, see parameters)
- terminate with a NUL on output (only a single NUL byte, not useful for charsets with multi-byte NULs), or set U_STRING_NOT_TERMINATED_WARNING if the output exactly fills the target buffer
- the pivot buffer can be provided internally; possible only for whole-string conversion, not streaming conversion; in this case, the caller will not be able to get details about where an error occurred (if pivotStart==NULL, see below)

The function returns when one of the following is true:

- the entire source text has been converted successfully to the target buffer
- a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR)
- a conversion error occurred (other U_FAILURE(), see description of pErrorCode)

Limitation compared to the direct use of ucnv_fromUnicode() and ucnv_toUnicode(): ucnv_convertEx() does not provide offset information.

Limitation compared to ucnv_fromUChars() and ucnv_toUChars(): ucnv_convertEx() does not support preflighting directly.

Sample code for converting a single string from one external charset to UTF-8, ignoring the location of errors:

int32_t
myToUTF8(UConverter *cnv,
const char *s, int32_t length,
char *u8, int32_t capacity,
UErrorCode *pErrorCode) {
UConverter *utf8Cnv;
char *target;
if(U_FAILURE(*pErrorCode)) {
return 0;
}
utf8Cnv=myGetCachedUTF8Converter(pErrorCode);
if(U_FAILURE(*pErrorCode)) {
return 0;
}
if(length<0) {
length=strlen(s);
}
target=u8;
ucnv_convertEx(utf8Cnv, cnv,
&target, u8+capacity,
&s, s+length,
NULL, NULL, NULL, NULL,
true, true,
pErrorCode);
myReleaseCachedUTF8Converter(utf8Cnv);
// return the output string length, but without preflighting
return (int32_t)(target-u8);
}
ucnv_convertEx
U_CAPI void ucnv_convertEx(UConverter *targetCnv, UConverter *sourceCnv, char **target, const char *targetLimit, const char **source, const char *sourceLimit, UChar *pivotStart, UChar **pivotSource, UChar **pivotTarget, const UChar *pivotLimit, UBool reset, UBool flush, UErrorCode *pErrorCode)
Convert from one external charset to another using two existing UConverters.
UConverter
struct UConverter UConverter
Definition: ucnv_err.h:96
NULL
#define NULL
Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
Definition: utypes.h:203
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:509
U_FAILURE
#define U_FAILURE(x)
Does the error code indicate a failure?
Definition: utypes.h:827

Parameters

  targetCnv | Output converter, used to convert from the UTF-16 pivot to the target using ucnv_fromUnicode().
  sourceCnv | Input converter, used to convert from the source to the UTF-16 pivot using ucnv_toUnicode().
  target | I/O parameter, same as for ucnv_fromUChars(). Input: *target points to the beginning of the target buffer. Output: *target points to the first unit after the last char written.
  targetLimit | Pointer to the first unit after the target buffer.
  source | I/O parameter, same as for ucnv_toUChars(). Input: *source points to the beginning of the source buffer. Output: *source points to the first unit after the last char read.
  sourceLimit | Pointer to the first unit after the source buffer.
  pivotStart | Pointer to the UTF-16 pivot buffer. If pivotStart==NULL, then an internal buffer is used and the other pivot arguments are ignored and can be NULL as well.
  pivotSource | I/O parameter, same as source in ucnv_fromUChars() for conversion from the pivot buffer to the target buffer.
  pivotTarget | I/O parameter, same as target in ucnv_toUChars() for conversion from the source buffer to the pivot buffer. It must be pivotStart<=*pivotSource<=*pivotTarget<=pivotLimit and pivotStart<pivotLimit (unless pivotStart==NULL).
  pivotLimit | Pointer to the first unit after the pivot buffer.
  reset | If true, then ucnv_resetToUnicode(sourceCnv) and ucnv_resetFromUnicode(targetCnv) are called, and the pivot pointers are reset (*pivotTarget=*pivotSource=pivotStart).
  flush | If true, indicates the end of the input. Passed directly to ucnv_toUnicode(), and carried over to ucnv_fromUnicode() when the source is empty as well.
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. U_BUFFER_OVERFLOW_ERROR always refers to the target buffer because overflows into the pivot buffer are handled internally. Other conversion errors are from the source-to-pivot conversion if *pivotSource==pivotStart, otherwise from the pivot-to-target conversion.

See also
  ucnv_convert
  ucnv_fromAlgorithmic
  ucnv_toAlgorithmic
  ucnv_fromUnicode
  ucnv_toUnicode
  ucnv_fromUChars
  ucnv_toUChars

Stable:
  ICU 2.6

## ◆ ucnv_countAliases()

U_CAPI uint16_t ucnv_countAliases | ( | const char * | alias,
|  | UErrorCode * | pErrorCode
| ) |  |

Gives the number of aliases for a given converter or alias name.

If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING. This method only enumerates the listed entries in the alias file.

Parameters

  alias | alias name
  pErrorCode | error status

Returns
  number of names on alias list for given alias

Stable:
  ICU 2.0

## ◆ ucnv_countAvailable()

U_CAPI int32_t ucnv_countAvailable | ( | void |  | ) |

Returns the number of available converters, as per the alias file.

Returns
  the number of available converters

See also
  ucnv_getAvailableName

Stable:
  ICU 2.0

## ◆ ucnv_countStandards()

U_CAPI uint16_t ucnv_countStandards | ( | void |  | ) |

Gives the number of standards associated to converter names.

Returns
  number of standards

Stable:
  ICU 2.0

## ◆ ucnv_detectUnicodeSignature()

U_CAPI const char* ucnv_detectUnicodeSignature | ( | const char * | source,
|  | int32_t | sourceLength,
|  | int32_t * | signatureLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Detects Unicode signature byte sequences at the start of the byte stream and returns the charset name of the indicated Unicode charset.

NULL is returned when no Unicode signature is recognized. The number of bytes in the signature is output as well.

The caller can ucnv_open() a converter using the charset name. The first code unit (UChar) from the start of the stream will be U+FEFF (the Unicode BOM/signature character) and can usually be ignored.

For most Unicode charsets it is also possible to ignore the indicated number of initial stream bytes and start converting after them. However, there are stateful Unicode charsets (UTF-7 and BOCU-1) for which this will not work. Therefore, it is best to ignore the first output UChar instead of the input signature bytes.

Usage:

Parameters

  source | The source string in which the signature should be detected.
  sourceLength | Length of the input string, or -1 if terminated with a NUL byte.
  signatureLength | A pointer to int32_t to receive the number of bytes that make up the signature of the detected UTF. 0 if not detected. Can be a NULL pointer.
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  The name of the encoding detected. NULL if encoding is not detected.

Stable:
  ICU 2.4

## ◆ ucnv_fixFileSeparator()

U_CAPI void ucnv_fixFileSeparator | ( | const UConverter * | cnv,
|  | UChar * | source,
|  | int32_t | sourceLen
| ) |  |

Fixes the backslash character mismapping.

For example, in SJIS, the backslash character in the ASCII portion is also used to represent the yen currency sign. When mapping from Unicode character 0x005C, it's unclear whether to map the character back to yen or backslash in SJIS. This function will take the input buffer and replace all the yen sign characters with backslash. This is necessary when the user tries to open a file with the input buffer on Windows. This function will test the converter to see whether such mapping is required. You can sometimes avoid using this function by using the correct version of Shift-JIS.

Parameters

  cnv | The converter representing the target codepage.
  source | the input buffer to be fixed
  sourceLen | the length of the input buffer

See also
  ucnv_isAmbiguous

Stable:
  ICU 2.0

## ◆ ucnv_flushCache()

U_CAPI int32_t ucnv_flushCache | ( | void |  | ) |

Frees up memory occupied by unused, cached converter shared data.

Returns
  the number of cached converters successfully deleted

See also
  ucnv_close

Stable:
  ICU 2.0

## ◆ ucnv_fromAlgorithmic()

U_CAPI int32_t ucnv_fromAlgorithmic | ( | UConverter * | cnv,
|  | UConverterType | algorithmicType,
|  | char * | target,
|  | int32_t | targetCapacity,
|  | const char * | source,
|  | int32_t | sourceLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert from one external charset to another.

Internally, the text is converted to and from the 16-bit Unicode "pivot" using ucnv_convertEx(). ucnv_fromAlgorithmic() works exactly like ucnv_convert() except that the two converters need not be looked up and opened completely.

The source-to-pivot conversion uses a purely algorithmic converter according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter. The pivot-to-target conversion uses the cnv converter parameter.

Internally, the algorithmic converter is opened and closed for each function call, which is more efficient than using the public ucnv_open() but somewhat less efficient than only resetting an existing converter and using ucnv_convertEx().

This function is more convenient than ucnv_convertEx() for single-string conversions, especially when "preflighting" is desired (returning the length of the complete output even if it does not fit into the target buffer; see the User Guide Strings chapter). See ucnv_convert() for details.

Parameters

  cnv | The converter that is used to convert from the UTF-16 pivot buffer to the target.
  algorithmicType | UConverterType constant identifying the desired source charset as a purely algorithmic converter. Those are converters for Unicode charsets like UTF-8, BOCU-1, SCSU, UTF-7, IMAP-mailbox-name, etc., as well as US-ASCII and ISO-8859-1.
  target | Pointer to the output buffer.
  targetCapacity | Capacity of the target, in bytes.
  source | Pointer to the input buffer.
  sourceLength | Length of the input text, in bytes
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.

See also
  ucnv_fromAlgorithmic
  ucnv_convert
  ucnv_convertEx
  ucnv_fromUnicode
  ucnv_toUnicode
  ucnv_fromUChars
  ucnv_toUChars

Stable:
  ICU 2.6

## ◆ ucnv_fromUChars()

U_CAPI int32_t ucnv_fromUChars | ( | UConverter * | cnv,
|  | char * | dest,
|  | int32_t | destCapacity,
|  | const UChar * | src,
|  | int32_t | srcLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert the Unicode string into a codepage string using an existing UConverter.

The output string is NUL-terminated if possible.

This function is a more convenient but less powerful version of ucnv_fromUnicode(). It is only useful for whole strings, not for streaming conversion.

The maximum output buffer capacity required (barring output from callbacks) will be UCNV_GET_MAX_BYTES_FOR_STRING(srcLength, ucnv_getMaxCharSize(cnv)).

Parameters

  cnv | the converter object to be used (ucnv_resetFromUnicode() will be called)
  src | the input Unicode string
  srcLength | the input string length, or -1 if NUL-terminated
  dest | destination string buffer, can be NULL if destCapacity==0
  destCapacity | the number of chars available at dest
  pErrorCode | normal ICU error code; common error codes that may be set by this function include U_BUFFER_OVERFLOW_ERROR, U_STRING_NOT_TERMINATED_WARNING, U_ILLEGAL_ARGUMENT_ERROR, and conversion errors

Returns
  the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in

See also
  ucnv_fromUnicode
  ucnv_convert
  UCNV_GET_MAX_BYTES_FOR_STRING

Stable:
  ICU 2.0

## ◆ ucnv_fromUCountPending()

U_CAPI int32_t ucnv_fromUCountPending | ( | const UConverter * | cnv,
|  | UErrorCode * | status
| ) |  |

Returns the number of UChars held in the converter's internal state because more input is needed for completing the conversion.

This function is useful for mapping semantics of ICU's converter interface to those of iconv, and this information is not needed for normal conversion.

Parameters

  cnv | The converter in which the input is held
  status | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  The number of UChars in the state. -1 if an error is encountered.

Stable:
  ICU 3.4

## ◆ ucnv_fromUnicode()

U_CAPI void ucnv_fromUnicode | ( | UConverter * | converter,
|  | char ** | target,
|  | const char * | targetLimit,
|  | const UChar ** | source,
|  | const UChar * | sourceLimit,
|  | int32_t * | offsets,
|  | UBool | flush,
|  | UErrorCode * | err
| ) |  |

Converts an array of unicode characters to an array of codepage characters.

This function is optimized for converting a continuous stream of data in buffer-sized chunks, where the entire source and target does not fit in available buffers.

The source pointer is an in/out parameter. It starts out pointing where the conversion is to begin, and ends up pointing after the last UChar consumed.

Target similarly starts out pointer at the first available byte in the output buffer, and ends up pointing after the last byte written to the output.

The converter always attempts to consume the entire source buffer, unless (1.) the target buffer is full, or (2.) a failing error is returned from the current callback function. When a successful error status has been returned, it means that all of the source buffer has been consumed. At that point, the caller should reset the source and sourceLimit pointers to point to the next chunk.

At the end of the stream (flush==true), the input is completely consumed when *source==sourceLimit and no error code is set. The converter object is then automatically reset by this function. (This means that a converter need not be reset explicitly between data streams if it finishes the previous stream without errors.)

This is a stateful conversion. Additionally, even when all source data has been consumed, some data may be in the converters' internal state. Call this function repeatedly, updating the target pointers with the next empty chunk of target in case of a `U_BUFFER_OVERFLOW_ERROR`, and updating the source pointers with the next chunk of source when a successful error status is returned, until there are no more chunks of source data.

Parameters

  converter | the Unicode converter
  target | I/O parameter. Input : Points to the beginning of the buffer to copy codepage characters to. Output : points to after the last codepage character copied to `target`.
  targetLimit | the pointer just after last of the `target` buffer
  source | I/O parameter, pointer to pointer to the source Unicode character buffer.
  sourceLimit | the pointer just after the last of the source buffer
  offsets | if NULL is passed, nothing will happen to it, otherwise it needs to have the same number of allocated cells as `target`. Will fill in offsets from target to source pointer e.g: `offsets[3]` is equal to 6, it means that the `target[3]` was a result of transcoding `source[6]` For output data carried across calls, and other data without a specific source character (such as from escape sequences or callbacks) -1 will be placed for offsets.
  flush | set to `true` if the current source buffer is the last available chunk of the source, `false` otherwise. Note that if a failing status is returned, this function may have to be called multiple times with flush set to `true` until the source buffer is consumed.
  err | the error status. `U_ILLEGAL_ARGUMENT_ERROR` will be set if the converter is `NULL`. `U_BUFFER_OVERFLOW_ERROR` will be set if the target is full and there is still data to be written to the target.

See also
  ucnv_fromUChars
  ucnv_convert
  ucnv_getMinCharSize
  ucnv_setToUCallBack

Stable:
  ICU 2.0

## ◆ ucnv_getAlias()

U_CAPI const char* ucnv_getAlias | ( | const char * | alias,
|  | uint16_t | n,
|  | UErrorCode * | pErrorCode
| ) |  |

Gives the name of the alias at given index of alias list.

This method only enumerates the listed entries in the alias file. If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.

Parameters

  alias | alias name
  n | index in alias list
  pErrorCode | result of operation

Returns
  returns the name of the alias at given index

See also
  ucnv_countAliases

Stable:
  ICU 2.0

## ◆ ucnv_getAliases()

U_CAPI void ucnv_getAliases | ( | const char * | alias,
|  | const char ** | aliases,
|  | UErrorCode * | pErrorCode
| ) |  |

Fill-up the list of alias names for the given alias.

This method only enumerates the listed entries in the alias file. If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.

Parameters

  alias | alias name
  aliases | fill-in list, aliases is a pointer to an array of `ucnv_countAliases()` string-pointers (`const char *`) that will be filled in. The strings themselves are owned by the library.
  pErrorCode | result of operation

Stable:
  ICU 2.0

## ◆ ucnv_getAvailableName()

U_CAPI const char* ucnv_getAvailableName | ( | int32_t | n | ) |

Gets the canonical converter name of the specified converter from a list of all available converters contained in the alias file.

All converters in this list can be opened.

Parameters

  n | the index to a converter available on the system (in the range `[0..ucnv_countAvailable()]`)

Returns
  a pointer a string (library owned), or `NULL` if the index is out of bounds.

See also
  ucnv_countAvailable

Stable:
  ICU 2.0

## ◆ ucnv_getCanonicalName()

U_CAPI const char* ucnv_getCanonicalName | ( | const char * | alias,
|  | const char * | standard,
|  | UErrorCode * | pErrorCode
| ) |  |

This function will return the internal canonical converter name of the tagged alias.

This is the opposite of ucnv_openStandardNames, which returns the tagged alias given the canonical name.

Example alias table:
conv alias1 { STANDARD1 } alias2 { STANDARD1* }

Result of ucnv_getStandardName("alias1", "STANDARD1") from example alias table:
"conv"

Returns
  returns the canonical converter name; if a standard or alias name cannot be determined, then `NULL` is returned. The returned string is owned by the library.

See also
  ucnv_getStandardName

Stable:
  ICU 2.4

## ◆ ucnv_getCCSID()

U_CAPI int32_t ucnv_getCCSID | ( | const UConverter * | converter,
|  | UErrorCode * | err
| ) |  |

Gets a codepage number associated with the converter.

This is not guaranteed to be the one used to create the converter. Some converters do not represent platform registered codepages and return zero for the codepage number. The error code fill-in parameter indicates if the codepage number is available. Does not check if the converter is `NULL` or if converter's data table is `NULL`.

Important: The use of CCSIDs is not recommended because it is limited to only two platforms in principle and only one (UCNV_IBM) in the current ICU converter API. Also, CCSIDs are insufficient to identify IBM Unicode conversion tables precisely. For more details see ucnv_openCCSID().

Parameters

  converter | the Unicode converter
  err | the error status code.

Returns
  If any error occurs, -1 will be returned otherwise, the codepage number will be returned

See also
  ucnv_openCCSID
  ucnv_getPlatform

Stable:
  ICU 2.0

## ◆ ucnv_getDefaultName()

U_CAPI const char* ucnv_getDefaultName | ( | void |  | ) |

Returns the current default converter name.

If you want to open a default converter, you do not need to use this function. It is faster if you pass a NULL argument to ucnv_open the default converter.

If U_CHARSET_IS_UTF8 is defined to 1 in utypes.h then this function always returns "UTF-8".

Returns
  returns the current default converter name. Storage owned by the library

See also
  ucnv_setDefaultName

Stable:
  ICU 2.0

## ◆ ucnv_getDisplayName()

U_CAPI int32_t ucnv_getDisplayName | ( | const UConverter * | converter,
|  | const char * | displayLocale,
|  | UChar * | displayName,
|  | int32_t | displayNameCapacity,
|  | UErrorCode * | err
| ) |  |

Returns the display name of the converter passed in based on the Locale passed in.

If the locale contains no display name, the internal ASCII name will be filled in.

Parameters

  converter | the Unicode converter.
  displayLocale | is the specific Locale we want to localized for
  displayName | user provided buffer to be filled in
  displayNameCapacity | size of displayName Buffer
  err | error status code

Returns
  displayNameLength number of UChar needed in displayName

See also
  ucnv_getName

Stable:
  ICU 2.0

## ◆ ucnv_getFromUCallBack()

U_CAPI void ucnv_getFromUCallBack | ( | const UConverter * | converter,
|  | UConverterFromUCallback * | action,
|  | const void ** | context
| ) |  |

Gets the current callback function used by the converter when illegal or invalid Unicode sequence is found.

Context pointers are always owned by the caller.

Parameters

  converter | the unicode converter
  action | fillin: returns the callback function pointer
  context | fillin: returns the callback's private void* context

See also
  ucnv_setFromUCallBack

Stable:
  ICU 2.0

## ◆ ucnv_getInvalidChars()

U_CAPI void ucnv_getInvalidChars | ( | const UConverter * | converter,
|  | char * | errBytes,
|  | int8_t * | len,
|  | UErrorCode * | err
| ) |  |

Fills in the output parameter, errBytes, with the error characters from the last failing conversion.

Parameters

  converter | the Unicode converter
  errBytes | the codepage bytes which were in error
  len | on input the capacity of errBytes, on output the number of bytes which were copied to it
  err | the error status code. If the substitution character array is too small, an `U_INDEX_OUTOFBOUNDS_ERROR` will be returned.

Stable:
  ICU 2.0

## ◆ ucnv_getInvalidUChars()

U_CAPI void ucnv_getInvalidUChars | ( | const UConverter * | converter,
|  | UChar * | errUChars,
|  | int8_t * | len,
|  | UErrorCode * | err
| ) |  |

Fills in the output parameter, errChars, with the error characters from the last failing conversion.

Parameters

  converter | the Unicode converter
  errUChars | the UChars which were in error
  len | on input the capacity of errUChars, on output the number of UChars which were copied to it
  err | the error status code. If the substitution character array is too small, an `U_INDEX_OUTOFBOUNDS_ERROR` will be returned.

Stable:
  ICU 2.0

## ◆ ucnv_getMaxCharSize()

U_CAPI int8_t ucnv_getMaxCharSize | ( | const UConverter * | converter | ) |

Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this converter.

The returned number can be used with UCNV_GET_MAX_BYTES_FOR_STRING to calculate the size of a target buffer for conversion from Unicode.

Note: Before ICU 2.8, this function did not return reliable numbers for some stateful converters (EBCDIC_STATEFUL, ISO-2022) and LMBCS.

This number may not be the same as the maximum number of bytes per "conversion unit". In other words, it may not be the intuitively expected number of bytes per character that would be published for a charset, and may not fulfill any other purpose than the allocation of an output buffer of guaranteed sufficient size for a given input length and converter.

Examples for special cases that are taken into account:

- Supplementary code points may convert to more bytes than BMP code points. This function returns bytes per UChar (UTF-16 code unit), not per Unicode code point, for efficient buffer allocation.
- State-shifting output (SI/SO, escapes, etc.) from stateful converters.
- When m input UChars are converted to n output bytes, then the maximum m/n is taken into account.

The number returned here does not take into account (see UCNV_GET_MAX_BYTES_FOR_STRING):

- callbacks which output more than one charset character sequence per call, like escape callbacks
- initial and final non-character bytes that are output by some converters (automatic BOMs, initial escape sequence, final SI, etc.)

Examples for returned values:

- SBCS charsets: 1
- Shift-JIS: 2
- UTF-16: 2 (2 per BMP, 4 per surrogate pair, BOM not counted)
- UTF-8: 3 (3 per BMP, 4 per surrogate pair)
- EBCDIC_STATEFUL (EBCDIC mixed SBCS/DBCS): 3 (SO + DBCS)
- ISO-2022: 3 (always outputs UTF-8)
- ISO-2022-JP: 6 (4-byte escape sequences + DBCS)
- ISO-2022-CN: 8 (4-byte designator sequences + 2-byte SS2/SS3 + DBCS)

Parameters

  converter | The Unicode converter.

Returns
  The maximum number of bytes per UChar (16 bit code unit) that are output by ucnv_fromUnicode(), to be used together with UCNV_GET_MAX_BYTES_FOR_STRING for buffer allocation.

See also
  UCNV_GET_MAX_BYTES_FOR_STRING
  ucnv_getMinCharSize

Stable:
  ICU 2.0

## ◆ ucnv_getMinCharSize()

U_CAPI int8_t ucnv_getMinCharSize | ( | const UConverter * | converter | ) |

Returns the minimum byte length (per codepoint) for characters in this codepage.

This is usually either 1 or 2.

Parameters

  converter | the Unicode converter

Returns
  the minimum number of bytes per codepoint allowed by this particular converter

See also
  ucnv_getMaxCharSize

Stable:
  ICU 2.0

## ◆ ucnv_getName()

U_CAPI const char* ucnv_getName | ( | const UConverter * | converter,
|  | UErrorCode * | err
| ) |  |

Gets the internal, canonical name of the converter (zero-terminated).

The lifetime of the returned string will be that of the converter passed to this function.

Parameters

  converter | the Unicode converter
  err | UErrorCode status

Returns
  the internal name of the converter

See also
  ucnv_getDisplayName

Stable:
  ICU 2.0

## ◆ ucnv_getNextUChar()

U_CAPI UChar32 ucnv_getNextUChar | ( | UConverter * | converter,
|  | const char ** | source,
|  | const char * | sourceLimit,
|  | UErrorCode * | err
| ) |  |

Convert a codepage buffer into Unicode one character at a time.

The input is completely consumed when the U_INDEX_OUTOFBOUNDS_ERROR is set.

Advantage compared to ucnv_toUnicode() or ucnv_toUChars():

- Faster for small amounts of data, for most converters, e.g., US-ASCII, ISO-8859-1, UTF-8/16/32, and most "normal" charsets. (For complex converters, e.g., SCSU, UTF-7 and ISO 2022 variants, it uses ucnv_toUnicode() internally.)
- Convenient.

Limitations compared to ucnv_toUnicode():

- Always assumes flush=true. This makes ucnv_getNextUChar() unsuitable for "streaming" conversion, that is, for where the input is supplied in multiple buffers, because ucnv_getNextUChar() will assume the end of the input at the end of the first buffer.
- Does not provide offset output.

It is possible to "mix" ucnv_getNextUChar() and ucnv_toUnicode() because ucnv_getNextUChar() uses the current state of the converter (unlike ucnv_toUChars() which always resets first). However, if ucnv_getNextUChar() is called after ucnv_toUnicode() stopped in the middle of a character sequence (with flush=false), then ucnv_getNextUChar() will always use the slower ucnv_toUnicode() internally until the next character boundary. (This is new in ICU 2.6. In earlier releases, ucnv_getNextUChar() had to start at a character boundary.)

Instead of using ucnv_getNextUChar(), it is recommended to convert using ucnv_toUnicode() or ucnv_toUChars() and then iterate over the text using U16_NEXT() or a UCharIterator (uiter.h) or a C++ CharacterIterator or similar. This allows streaming conversion and offset output, for example.

Handling of surrogate pairs and supplementary-plane code points:
There are two different kinds of codepages that provide mappings for surrogate characters:

- Codepages like UTF-8, UTF-32, and GB 18030 provide direct representations for Unicode code points U+10000-U+10ffff as well as for single surrogates U+d800-U+dfff. Each valid sequence will result in exactly one returned code point. If a sequence results in a single surrogate, then that will be returned by itself, even if a neighboring sequence encodes the matching surrogate.
- Codepages like SCSU and LMBCS (and UTF-16) provide direct representations only for BMP code points including surrogates. Code points in supplementary planes are represented with two sequences, each encoding a surrogate. For these codepages, matching pairs of surrogates will be combined into single code points for returning from this function. (Note that SCSU is actually a mix of these codepage types.)

Parameters

  converter | an open UConverter
  source | the address of a pointer to the codepage buffer, will be updated to point after the bytes consumed in the conversion call.
  sourceLimit | points to the end of the input buffer
  err | fills in error status (see ucnv_toUnicode) `U_INDEX_OUTOFBOUNDS_ERROR` will be set if the input is empty or does not convert to any output (e.g.: pure state-change codes SI/SO, escape sequences for ISO 2022, or if the callback did not output anything, ...). This function will not set a `U_BUFFER_OVERFLOW_ERROR` because the "buffer" is the return code. However, there might be subsequent output stored in the converter object that will be returned in following calls to this function.

Returns
  a UChar32 resulting from the partial conversion of source

See also
  ucnv_toUnicode
  ucnv_toUChars
  ucnv_convert

Stable:
  ICU 2.0

## ◆ ucnv_getPlatform()

U_CAPI UConverterPlatform ucnv_getPlatform | ( | const UConverter * | converter,
|  | UErrorCode * | err
| ) |  |

Gets a codepage platform associated with the converter.

Currently, only `UCNV_IBM` will be returned. Does not test if the converter is `NULL` or if converter's data table is `NULL`.

Parameters

  converter | the Unicode converter
  err | the error status code.

Returns
  The codepage platform

Stable:
  ICU 2.0

## ◆ ucnv_getStandard()

U_CAPI const char* ucnv_getStandard | ( | uint16_t | n,
|  | UErrorCode * | pErrorCode
| ) |  |

Gives the name of the standard at given index of standard list.

Parameters

  n | index in standard list
  pErrorCode | result of operation

Returns
  returns the name of the standard at given index. Owned by the library.

Stable:
  ICU 2.0

## ◆ ucnv_getStandardName()

U_CAPI const char* ucnv_getStandardName | ( | const char * | name,
|  | const char * | standard,
|  | UErrorCode * | pErrorCode
| ) |  |

Returns a standard name for a given converter name.

Example alias table:
conv alias1 { STANDARD1 } alias2 { STANDARD1* }

Result of ucnv_getStandardName("conv", "STANDARD1") from example alias table:
"alias2"

Parameters

  name | original converter name
  standard | name of the standard governing the names; MIME and IANA are such standards
  pErrorCode | result of operation

Returns
  returns the standard converter name; if a standard converter name cannot be determined, then `NULL` is returned. Owned by the library.

Stable:
  ICU 2.0

## ◆ ucnv_getStarters()

U_CAPI void ucnv_getStarters | ( | const UConverter * | converter,
|  | UBool | starters[256],
|  | UErrorCode * | err
| ) |  |

Gets the "starter" (lead) bytes for converters of type MBCS.

Will fill in an `U_ILLEGAL_ARGUMENT_ERROR` if converter passed in is not MBCS. Fills in an array of type UBool, with the value of the byte as offset to the array. For example, if (starters[0x20] == true) at return, it means that the byte 0x20 is a starter byte in this converter. Context pointers are always owned by the caller.

Parameters

  converter | a valid, opened converter of type MBCS
  starters | an array of size 256 to be filled in
  err | error status, `U_ILLEGAL_ARGUMENT_ERROR` if the converter is not a type which can return starters.

See also
  ucnv_getType

Stable:
  ICU 2.0

## ◆ ucnv_getSubstChars()

U_CAPI void ucnv_getSubstChars | ( | const UConverter * | converter,
|  | char * | subChars,
|  | int8_t * | len,
|  | UErrorCode * | err
| ) |  |

Fills in the output parameter, subChars, with the substitution characters as multiple bytes.

If ucnv_setSubstString() set a Unicode string because the converter is stateful, then subChars will be an empty string.

Parameters

  converter | the Unicode converter
  subChars | the substitution characters
  len | on input the capacity of subChars, on output the number of bytes copied to it
  err | the outgoing error status code. If the substitution character array is too small, an `U_INDEX_OUTOFBOUNDS_ERROR` will be returned.

See also
  ucnv_setSubstString
  ucnv_setSubstChars

Stable:
  ICU 2.0

## ◆ ucnv_getToUCallBack()

U_CAPI void ucnv_getToUCallBack | ( | const UConverter * | converter,
|  | UConverterToUCallback * | action,
|  | const void ** | context
| ) |  |

Gets the current callback function used by the converter when an illegal or invalid codepage sequence is found.

Context pointers are always owned by the caller.

Parameters

  converter | the unicode converter
  action | fillin: returns the callback function pointer
  context | fillin: returns the callback's private void* context

See also
  ucnv_setToUCallBack

Stable:
  ICU 2.0

## ◆ ucnv_getType()

U_CAPI UConverterType ucnv_getType | ( | const UConverter * | converter | ) |

Gets the type of the converter e.g.

SBCS, MBCS, DBCS, UTF8, UTF16_BE, UTF16_LE, ISO_2022, EBCDIC_STATEFUL, LATIN_1

Parameters

  converter | a valid, opened converter

Returns
  the type of the converter

Stable:
  ICU 2.0

## ◆ ucnv_getUnicodeSet()

U_CAPI void ucnv_getUnicodeSet | ( | const UConverter * | cnv,
|  | USet * | setFillIn,
|  | UConverterUnicodeSet | whichSet,
|  | UErrorCode * | pErrorCode
| ) |  |

Returns the set of Unicode code points that can be converted by an ICU converter.

Returns one of several kinds of set:

1. UCNV_ROUNDTRIP_SET

The set of all Unicode code points that can be roundtrip-converted (converted without any data loss) with the converter (ucnv_fromUnicode()). This set will not include code points that have fallback mappings or are only the result of reverse fallback mappings. This set will also not include PUA code points with fallbacks, although ucnv_fromUnicode() will always uses those mappings despite ucnv_setFallback(). See UTR #22 "Character Mapping Markup Language" at http://www.unicode.org/reports/tr22/

This is useful for example for

- checking that a string or document can be roundtrip-converted with a converter, without/before actually performing the conversion
- testing if a converter can be used for text for typical text for a certain locale, by comparing its roundtrip set with the set of ExemplarCharacters from ICU's locale data or other sources

1. UCNV_ROUNDTRIP_AND_FALLBACK_SET

The set of all Unicode code points that can be converted with the converter (ucnv_fromUnicode()) when fallbacks are turned on (see ucnv_setFallback()). This set includes all code points with roundtrips and fallbacks (but not reverse fallbacks).

In the future, there may be more UConverterUnicodeSet choices to select sets with different properties.

Parameters

  cnv | The converter for which a set is requested.
  setFillIn | A valid USet *. It will be cleared by this function before the converter's specific set is filled into the USet.
  whichSet | A UConverterUnicodeSet selector; currently UCNV_ROUNDTRIP_SET is the only supported value.
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

See also
  UConverterUnicodeSet
  uset_open
  uset_close

Stable:
  ICU 2.6

## ◆ ucnv_isAmbiguous()

U_CAPI UBool ucnv_isAmbiguous | ( | const UConverter * | cnv | ) |

Determines if the converter contains ambiguous mappings of the same character or not.

Parameters

  cnv | the converter to be tested

Returns
  true if the converter contains ambiguous mapping of the same character, false otherwise.

Stable:
  ICU 2.0

## ◆ ucnv_isFixedWidth()

U_CAPI UBool ucnv_isFixedWidth | ( | UConverter * | cnv,
|  | UErrorCode * | status
| ) |  |

Returns whether or not the charset of the converter has a fixed number of bytes per charset character.

An example of this are converters that are of the type UCNV_SBCS or UCNV_DBCS. Another example is UTF-32 which is always 4 bytes per character. A Unicode code point may be represented by more than one UTF-8 or UTF-16 code unit but a UTF-32 converter encodes each code point with 4 bytes. Note: This method is not intended to be used to determine whether the charset has a fixed ratio of bytes to Unicode codes units for any particular Unicode encoding form. false is returned with the UErrorCode if error occurs or cnv is NULL.

Parameters

  cnv | The converter to be tested
  status | ICU error code in/out parameter

Returns
  true if the converter is fixed-width

Stable:
  ICU 4.8

## ◆ ucnv_open()

U_CAPI UConverter* ucnv_open | ( | const char * | converterName,
|  | UErrorCode * | err
| ) |  |

Creates a UConverter object with the name of a coded character set specified as a C string.

The actual name will be resolved with the alias file using a case-insensitive string comparison that ignores leading zeroes and all non-alphanumeric characters. E.g., the names "UTF8", "utf-8", "u*T@f08" and "Utf 8" are all equivalent. (See also ucnv_compareNames().) If `NULL` is passed for the converter name, it will create one with the getDefaultName return value.

A converter name for ICU 1.5 and above may contain options like a locale specification to control the specific behavior of the newly instantiated converter. The meaning of the options depends on the particular converter. If an option is not defined for or recognized by a given converter, then it is ignored.

Options are appended to the converter name string, with a `UCNV_OPTION_SEP_CHAR` between the name and the first option and also between adjacent options.

If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.

The conversion behavior and names can vary between platforms. ICU may convert some characters differently from other platforms. Details on this topic are in the User Guide. Aliases starting with a "cp" prefix have no specific meaning other than its an alias starting with the letters "cp". Please do not associate any meaning to these aliases.

Parameters

  converterName | Name of the coded character set table. This may have options appended to the string. IANA alias character set names, IBM CCSIDs starting with "ibm-", Windows codepage numbers starting with "windows-" are frequently used for this parameter. See ucnv_getAvailableName and ucnv_getAlias for a complete list that is available. If this parameter is NULL, the default converter will be used.
  err | outgoing error status `U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR`

Returns
  the created Unicode converter object, or `NULL` if an error occurred

See also
  ucnv_openU
  ucnv_openCCSID
  ucnv_getAvailableName
  ucnv_getAlias
  ucnv_getDefaultName
  ucnv_close
  ucnv_compareNames

Stable:
  ICU 2.0

## ◆ ucnv_openAllNames()

U_CAPI UEnumeration* ucnv_openAllNames | ( | UErrorCode * | pErrorCode | ) |

Returns a UEnumeration to enumerate all of the canonical converter names, as per the alias file, regardless of the ability to open each converter.

Returns
  A UEnumeration object for getting all the recognized canonical converter names.

See also
  ucnv_getAvailableName
  uenum_close
  uenum_next

Stable:
  ICU 2.4

## ◆ ucnv_openCCSID()

U_CAPI UConverter* ucnv_openCCSID | ( | int32_t | codepage,
|  | UConverterPlatform | platform,
|  | UErrorCode * | err
| ) |  |

Creates a UConverter object from a CCSID number and platform pair.

Note that the usefulness of this function is limited to platforms with numeric encoding IDs. Only IBM and Microsoft platforms use numeric (16-bit) identifiers for encodings.

In addition, IBM CCSIDs and Unicode conversion tables are not 1:1 related. For many IBM CCSIDs there are multiple (up to six) Unicode conversion tables, and for some Unicode conversion tables there are multiple CCSIDs. Some "alternate" Unicode conversion tables are provided by the IBM CDRA conversion table registry. The most prominent example of a systematic modification of conversion tables that is not provided in the form of conversion table files in the repository is that S/390 Unix System Services swaps the codes for Line Feed and New Line in all EBCDIC codepages, which requires such a swap in the Unicode conversion tables as well.

Only IBM default conversion tables are accessible with ucnv_openCCSID(). ucnv_getCCSID() will return the same CCSID for all conversion tables that are associated with that CCSID.

Currently, the only "platform" supported in the ICU converter API is UCNV_IBM.

In summary, the use of CCSIDs and the associated API functions is not recommended.

In order to open a converter with the default IBM CDRA Unicode conversion table, you can use this function or use the prefix "ibm-":

char name[20];
sprintf(name, "ibm-%hu", ccsid);
cnv=ucnv_open(name, &errorCode);

In order to open a converter with the IBM S/390 Unix System Services variant of a Unicode/EBCDIC conversion table, you can use the prefix "ibm-" together with the option string UCNV_SWAP_LFNL_OPTION_STRING:

char name[20];
sprintf(name, "ibm-%hu" UCNV_SWAP_LFNL_OPTION_STRING, ccsid);
cnv=ucnv_open(name, &errorCode);
UCNV_SWAP_LFNL_OPTION_STRING
#define UCNV_SWAP_LFNL_OPTION_STRING
Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages.
Definition: ucnv.h:296

In order to open a converter from a Microsoft codepage number, use the prefix "cp":

char name[20];
sprintf(name, "cp%hu", codepageID);
cnv=ucnv_open(name, &errorCode);

If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.

Parameters

  codepage | codepage number to create
  platform | the platform in which the codepage number exists
  err | error status `U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR`

Returns
  the created Unicode converter object, or `NULL` if an error occurred.

See also
  ucnv_open
  ucnv_openU
  ucnv_close
  ucnv_getCCSID
  ucnv_getPlatform
  UConverterPlatform

Stable:
  ICU 2.0

## ◆ ucnv_openPackage()

U_CAPI UConverter* ucnv_openPackage | ( | const char * | packageName,
|  | const char * | converterName,
|  | UErrorCode * | err
| ) |  |

Creates a UConverter object specified from a packageName and a converterName.

The packageName and converterName must point to an ICU udata object, as defined by `udata_open( packageName, "cnv", converterName, err)` or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with udata_setAppData(). Using a full file or directory pathname for packageName is deprecated.

The name will NOT be looked up in the alias mechanism, nor will the converter be stored in the converter cache or the alias table. The only way to open further converters is call this function multiple times, or use the ucnv_clone() function to clone a 'primary' converter.

A future version of ICU may add alias table lookups and/or caching to this function.

Example Use: `cnv = ucnv_openPackage("myapp", "myconverter", &err);`

Parameters

  packageName | name of the package (equivalent to 'path' in udata_open() call)
  converterName | name of the data item to be used, without suffix.
  err | outgoing error status `U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR`

Returns
  the created Unicode converter object, or `NULL` if an error occurred

See also
  udata_open
  ucnv_open
  ucnv_clone
  ucnv_close

Stable:
  ICU 2.2

## ◆ ucnv_openStandardNames()

U_CAPI UEnumeration* ucnv_openStandardNames | ( | const char * | convName,
|  | const char * | standard,
|  | UErrorCode * | pErrorCode
| ) |  |

Return a new UEnumeration object for enumerating all the alias names for a given converter that are recognized by a standard.

This method only enumerates the listed entries in the alias file. The convrtrs.txt file can be modified to change the results of this function. The first result in this list is the same result given by `ucnv_getStandardName`, which is the default alias for the specified standard name. The returned object must be closed with `uenum_close` when you are done with the object.

Parameters

  convName | original converter name
  standard | name of the standard governing the names; MIME and IANA are such standards
  pErrorCode | The error code

Returns
  A UEnumeration object for getting all aliases that are recognized by a standard. If any of the parameters are invalid, NULL is returned.

See also
  ucnv_getStandardName
  uenum_close
  uenum_next

Stable:
  ICU 2.2

## ◆ ucnv_openU()

U_CAPI UConverter* ucnv_openU | ( | const UChar * | name,
|  | UErrorCode * | err
| ) |  |

Creates a Unicode converter with the names specified as unicode string.

The name should be limited to the ASCII-7 alphanumerics range. The actual name will be resolved with the alias file using a case-insensitive string comparison that ignores leading zeroes and all non-alphanumeric characters. E.g., the names "UTF8", "utf-8", "u*T@f08" and "Utf 8" are all equivalent. (See also ucnv_compareNames().) If `NULL` is passed for the converter name, it will create one with the ucnv_getDefaultName() return value. If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.

See ucnv_open for the complete details

Parameters

  name | Name of the UConverter table in a zero terminated Unicode string
  err | outgoing error status `U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR`

Returns
  the created Unicode converter object, or `NULL` if an error occurred

See also
  ucnv_open
  ucnv_openCCSID
  ucnv_close
  ucnv_compareNames

Stable:
  ICU 2.0

## ◆ ucnv_reset()

U_CAPI void ucnv_reset | ( | UConverter * | converter | ) |

Resets the state of a converter to the default state.

This is used in the case of an error, to restart a conversion from a known default state. It will also empty the internal output buffers.

Parameters

  converter | the Unicode converter

Stable:
  ICU 2.0

## ◆ ucnv_resetFromUnicode()

U_CAPI void ucnv_resetFromUnicode | ( | UConverter * | converter | ) |

Resets the from-Unicode part of a converter state to the default state.

This is used in the case of an error to restart a conversion from Unicode to a known default state. It will also empty the internal output buffers used for the conversion from Unicode codepoints.

Parameters

  converter | the Unicode converter

Stable:
  ICU 2.0

## ◆ ucnv_resetToUnicode()

U_CAPI void ucnv_resetToUnicode | ( | UConverter * | converter | ) |

Resets the to-Unicode part of a converter state to the default state.

This is used in the case of an error to restart a conversion to Unicode to a known default state. It will also empty the internal output buffers used for the conversion to Unicode codepoints.

Parameters

  converter | the Unicode converter

Stable:
  ICU 2.0

## ◆ ucnv_safeClone()

UConverter* ucnv_safeClone | ( | const UConverter * | cnv,
|  | void * | stackBuffer,
|  | int32_t * | pBufferSize,
|  | UErrorCode * | status
| ) |  |

Thread safe converter cloning operation.

For most efficient operation, pass in a stackBuffer (and a *pBufferSize) with at least U_CNV_SAFECLONE_BUFFERSIZE bytes of space. If the buffer size is sufficient, then the clone will use the stack buffer; otherwise, it will be allocated, and *pBufferSize will indicate the actual size. (This should not occur with U_CNV_SAFECLONE_BUFFERSIZE.)

You must ucnv_close() the clone in any case.

If *pBufferSize==0, (regardless of whether stackBuffer==NULL or not) then *pBufferSize will be changed to a sufficient size for cloning this converter, without actually cloning the converter ("pure pre-flighting").

If *pBufferSize is greater than zero but not large enough for a stack-based clone, then the converter is cloned using newly allocated memory and *pBufferSize is changed to the necessary size.

If the converter clone fits into the stack buffer but the stack buffer is not sufficiently aligned for the clone, then the clone will use an adjusted pointer and use an accordingly smaller buffer size.

Parameters

  cnv | converter to be cloned
  stackBuffer | Deprecated functionality as of ICU 52, use NULL. user allocated space for the new clone. If NULL new memory will be allocated. If buffer is not large enough, new memory will be allocated. Clients can use the U_CNV_SAFECLONE_BUFFERSIZE. This will probably be enough to avoid memory allocations.
  pBufferSize | Deprecated functionality as of ICU 52, use NULL or 1. pointer to size of allocated space.
  status | to indicate whether the operation went on smoothly or there were errors An informational status value, U_SAFECLONE_ALLOCATED_WARNING, is used if pBufferSize != NULL and any allocations were necessary However, it is better to check if *pBufferSize grew for checking for allocations because warning codes can be overridden by subsequent function calls.

Returns
  pointer to the new clone

Deprecated:
  ICU 71 Use ucnv_clone() instead.

## ◆ ucnv_setDefaultName()

U_CAPI void ucnv_setDefaultName | ( | const char * | name | ) |

This function is not thread safe.

DO NOT call this function when ANY ICU function is being used from more than one thread! This function sets the current default converter name. If this function needs to be called, it should be called during application initialization. Most of the time, the results from ucnv_getDefaultName() or ucnv_open with a NULL string argument is sufficient for your application.

If U_CHARSET_IS_UTF8 is defined to 1 in utypes.h then this function does nothing.

Parameters

  name | the converter name to be the default (must be known by ICU).

See also
  ucnv_getDefaultName

System:
  Do not use unless you know what you are doing.

Stable:
  ICU 2.0

## ◆ ucnv_setFallback()

U_CAPI void ucnv_setFallback | ( | UConverter * | cnv,
|  | UBool | usesFallback
| ) |  |

Sets the converter to use fallback mappings or not.

Regardless of this flag, the converter will always use fallbacks from Unicode Private Use code points, as well as reverse fallbacks (to Unicode). For details see ".ucm File Format" in the Conversion Data chapter of the ICU User Guide: https://unicode-org.github.io/icu/userguide/conversion/data.html#ucm-file-format

Parameters

  cnv | The converter to set the fallback mapping usage on.
  usesFallback | true if the user wants the converter to take advantage of the fallback mapping, false otherwise.

Stable:
  ICU 2.0

See also
  ucnv_usesFallback

## ◆ ucnv_setFromUCallBack()

U_CAPI void ucnv_setFromUCallBack | ( | UConverter * | converter,
|  | UConverterFromUCallback | newAction,
|  | const void * | newContext,
|  | UConverterFromUCallback * | oldAction,
|  | const void ** | oldContext,
|  | UErrorCode * | err
| ) |  |

Changes the current callback function used by the converter when an illegal or invalid sequence is found.

Context pointers are always owned by the caller. Predefined actions and contexts can be found in the ucnv_err.h header.

Parameters

  converter | the unicode converter
  newAction | the new callback function
  newContext | the new fromUnicode callback context pointer. This can be NULL.
  oldAction | fillin: returns the old callback function pointer. This can be NULL.
  oldContext | fillin: returns the old callback's private void* context. This can be NULL.
  err | The error code status

See also
  ucnv_getFromUCallBack

Stable:
  ICU 2.0

## ◆ ucnv_setSubstChars()

U_CAPI void ucnv_setSubstChars | ( | UConverter * | converter,
|  | const char * | subChars,
|  | int8_t | len,
|  | UErrorCode * | err
| ) |  |

Sets the substitution chars when converting from unicode to a codepage.

The substitution is specified as a string of 1-4 bytes, and may contain `NULL` bytes. The subChars must represent a single character. The caller needs to know the byte sequence of a valid character in the converter's charset. For some converters, for example some ISO 2022 variants, only single-byte substitution characters may be supported. The newer ucnv_setSubstString() function relaxes these limitations.

Parameters

  converter | the Unicode converter
  subChars | the substitution character byte sequence we want set
  len | the number of bytes in subChars
  err | the error status code. `U_INDEX_OUTOFBOUNDS_ERROR` if len is bigger than the maximum number of bytes allowed in subchars

See also
  ucnv_setSubstString
  ucnv_getSubstChars

Stable:
  ICU 2.0

## ◆ ucnv_setSubstString()

U_CAPI void ucnv_setSubstString | ( | UConverter * | cnv,
|  | const UChar * | s,
|  | int32_t | length,
|  | UErrorCode * | err
| ) |  |

Set a substitution string for converting from Unicode to a charset.

The caller need not know the charset byte sequence for each charset.

Unlike ucnv_setSubstChars() which is designed to set a charset byte sequence for a single character, this function takes a Unicode string with zero, one or more characters, and immediately verifies that the string can be converted to the charset. If not, or if the result is too long (more than 32 bytes as of ICU 3.6), then the function returns with an error accordingly.

Also unlike ucnv_setSubstChars(), this function works for stateful charsets by converting on the fly at the point of substitution rather than setting a fixed byte sequence.

Parameters

  cnv | The UConverter object.
  s | The Unicode string.
  length | The number of UChars in s, or -1 for a NUL-terminated string.
  err | Pointer to a standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)

See also
  ucnv_setSubstChars
  ucnv_getSubstChars

Stable:
  ICU 3.6

## ◆ ucnv_setToUCallBack()

U_CAPI void ucnv_setToUCallBack | ( | UConverter * | converter,
|  | UConverterToUCallback | newAction,
|  | const void * | newContext,
|  | UConverterToUCallback * | oldAction,
|  | const void ** | oldContext,
|  | UErrorCode * | err
| ) |  |

Changes the callback function used by the converter when an illegal or invalid sequence is found.

Context pointers are always owned by the caller. Predefined actions and contexts can be found in the ucnv_err.h header.

Parameters

  converter | the unicode converter
  newAction | the new callback function
  newContext | the new toUnicode callback context pointer. This can be NULL.
  oldAction | fillin: returns the old callback function pointer. This can be NULL.
  oldContext | fillin: returns the old callback's private void* context. This can be NULL.
  err | The error code status

See also
  ucnv_getToUCallBack

Stable:
  ICU 2.0

## ◆ ucnv_toAlgorithmic()

U_CAPI int32_t ucnv_toAlgorithmic | ( | UConverterType | algorithmicType,
|  | UConverter * | cnv,
|  | char * | target,
|  | int32_t | targetCapacity,
|  | const char * | source,
|  | int32_t | sourceLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert from one external charset to another.

Internally, the text is converted to and from the 16-bit Unicode "pivot" using ucnv_convertEx(). ucnv_toAlgorithmic() works exactly like ucnv_convert() except that the two converters need not be looked up and opened completely.

The source-to-pivot conversion uses the cnv converter parameter. The pivot-to-target conversion uses a purely algorithmic converter according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter.

Internally, the algorithmic converter is opened and closed for each function call, which is more efficient than using the public ucnv_open() but somewhat less efficient than only resetting an existing converter and using ucnv_convertEx().

This function is more convenient than ucnv_convertEx() for single-string conversions, especially when "preflighting" is desired (returning the length of the complete output even if it does not fit into the target buffer; see the User Guide Strings chapter). See ucnv_convert() for details.

Parameters

  algorithmicType | UConverterType constant identifying the desired target charset as a purely algorithmic converter. Those are converters for Unicode charsets like UTF-8, BOCU-1, SCSU, UTF-7, IMAP-mailbox-name, etc., as well as US-ASCII and ISO-8859-1.
  cnv | The converter that is used to convert from the source to the UTF-16 pivot buffer.
  target | Pointer to the output buffer.
  targetCapacity | Capacity of the target, in bytes.
  source | Pointer to the input buffer.
  sourceLength | Length of the input text, in bytes
  pErrorCode | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.

See also
  ucnv_fromAlgorithmic
  ucnv_convert
  ucnv_convertEx
  ucnv_fromUnicode
  ucnv_toUnicode
  ucnv_fromUChars
  ucnv_toUChars

Stable:
  ICU 2.6

## ◆ ucnv_toUChars()

U_CAPI int32_t ucnv_toUChars | ( | UConverter * | cnv,
|  | UChar * | dest,
|  | int32_t | destCapacity,
|  | const char * | src,
|  | int32_t | srcLength,
|  | UErrorCode * | pErrorCode
| ) |  |

Convert the codepage string into a Unicode string using an existing UConverter.

The output string is NUL-terminated if possible.

This function is a more convenient but less powerful version of ucnv_toUnicode(). It is only useful for whole strings, not for streaming conversion.

The maximum output buffer capacity required (barring output from callbacks) will be 2*srcLength (each char may be converted into a surrogate pair).

Parameters

  cnv | the converter object to be used (ucnv_resetToUnicode() will be called)
  src | the input codepage string
  srcLength | the input string length, or -1 if NUL-terminated
  dest | destination string buffer, can be NULL if destCapacity==0
  destCapacity | the number of UChars available at dest
  pErrorCode | normal ICU error code; common error codes that may be set by this function include U_BUFFER_OVERFLOW_ERROR, U_STRING_NOT_TERMINATED_WARNING, U_ILLEGAL_ARGUMENT_ERROR, and conversion errors

Returns
  the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in

See also
  ucnv_toUnicode
  ucnv_convert

Stable:
  ICU 2.0

## ◆ ucnv_toUCountPending()

U_CAPI int32_t ucnv_toUCountPending | ( | const UConverter * | cnv,
|  | UErrorCode * | status
| ) |  |

Returns the number of chars held in the converter's internal state because more input is needed for completing the conversion.

This function is useful for mapping semantics of ICU's converter interface to those of iconv, and this information is not needed for normal conversion.

Parameters

  cnv | The converter in which the input is held as internal state
  status | ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns
  The number of chars in the state. -1 if an error is encountered.

Stable:
  ICU 3.4

## ◆ ucnv_toUnicode()

U_CAPI void ucnv_toUnicode | ( | UConverter * | converter,
|  | UChar ** | target,
|  | const UChar * | targetLimit,
|  | const char ** | source,
|  | const char * | sourceLimit,
|  | int32_t * | offsets,
|  | UBool | flush,
|  | UErrorCode * | err
| ) |  |

Converts a buffer of codepage bytes into an array of unicode UChars characters.

This function is optimized for converting a continuous stream of data in buffer-sized chunks, where the entire source and target does not fit in available buffers.

The source pointer is an in/out parameter. It starts out pointing where the conversion is to begin, and ends up pointing after the last byte of source consumed.

Target similarly starts out pointer at the first available UChar in the output buffer, and ends up pointing after the last UChar written to the output. It does NOT necessarily keep UChar sequences together.

The converter always attempts to consume the entire source buffer, unless (1.) the target buffer is full, or (2.) a failing error is returned from the current callback function. When a successful error status has been returned, it means that all of the source buffer has been consumed. At that point, the caller should reset the source and sourceLimit pointers to point to the next chunk.

At the end of the stream (flush==true), the input is completely consumed when *source==sourceLimit and no error code is set The converter object is then automatically reset by this function. (This means that a converter need not be reset explicitly between data streams if it finishes the previous stream without errors.)

This is a stateful conversion. Additionally, even when all source data has been consumed, some data may be in the converters' internal state. Call this function repeatedly, updating the target pointers with the next empty chunk of target in case of a `U_BUFFER_OVERFLOW_ERROR`, and updating the source pointers with the next chunk of source when a successful error status is returned, until there are no more chunks of source data.

Parameters

  converter | the Unicode converter
  target | I/O parameter. Input : Points to the beginning of the buffer to copy UChars into. Output : points to after the last UChar copied.
  targetLimit | the pointer just after the end of the `target` buffer
  source | I/O parameter, pointer to pointer to the source codepage buffer.
  sourceLimit | the pointer to the byte after the end of the source buffer
  offsets | if NULL is passed, nothing will happen to it, otherwise it needs to have the same number of allocated cells as `target`. Will fill in offsets from target to source pointer e.g: `offsets[3]` is equal to 6, it means that the `target[3]` was a result of transcoding `source[6]` For output data carried across calls, and other data without a specific source character (such as from escape sequences or callbacks) -1 will be placed for offsets.
  flush | set to `true` if the current source buffer is the last available chunk of the source, `false` otherwise. Note that if a failing status is returned, this function may have to be called multiple times with flush set to `true` until the source buffer is consumed.
  err | the error status. `U_ILLEGAL_ARGUMENT_ERROR` will be set if the converter is `NULL`. `U_BUFFER_OVERFLOW_ERROR` will be set if the target is full and there is still data to be written to the target.

See also
  ucnv_fromUChars
  ucnv_convert
  ucnv_getMinCharSize
  ucnv_setFromUCallBack
  ucnv_getNextUChar

Stable:
  ICU 2.0

## ◆ ucnv_usesFallback()

U_CAPI UBool ucnv_usesFallback | ( | const UConverter * | cnv | ) |

Determines if the converter uses fallback mappings or not.

This flag has restrictions, see ucnv_setFallback().

Parameters

  cnv | The converter to be tested

Returns
  true if the converter uses fallback, false otherwise.

Stable:
  ICU 2.0

See also
  ucnv_setFallback