<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ICU 58.2: ucnv.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ucnv.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Character conversion.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="ucnv__err_8h_source.html">unicode/ucnv_err.h</a>"</code><br />
<code>#include "<a class="el" href="uenum_8h_source.html">unicode/uenum.h</a>"</code><br />
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br />
</div>
<p><a href="ucnv_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3ab00bb423db8533da12c35848e4c281"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a3ab00bb423db8533da12c35848e4c281">UCNV_MAX_CONVERTER_NAME_LENGTH</a>   60</td></tr>
<tr class="memdesc:a3ab00bb423db8533da12c35848e4c281"><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of a converter name including the terminating NULL. <a href="#a3ab00bb423db8533da12c35848e4c281">More...</a><br /></td></tr>
<tr class="separator:a3ab00bb423db8533da12c35848e4c281"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a579f67d05b09f731df5a68eb80b851"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1a579f67d05b09f731df5a68eb80b851">UCNV_MAX_FULL_FILE_NAME_LENGTH</a>   (600+<a class="el" href="ucnv_8h.html#a3ab00bb423db8533da12c35848e4c281">UCNV_MAX_CONVERTER_NAME_LENGTH</a>)</td></tr>
<tr class="memdesc:a1a579f67d05b09f731df5a68eb80b851"><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of a converter name including path and terminating NULL. <a href="#a1a579f67d05b09f731df5a68eb80b851">More...</a><br /></td></tr>
<tr class="separator:a1a579f67d05b09f731df5a68eb80b851"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a082aba7f50746ff6135a4ca2a00f6d6c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a082aba7f50746ff6135a4ca2a00f6d6c">UCNV_SI</a>   0x0F</td></tr>
<tr class="memdesc:a082aba7f50746ff6135a4ca2a00f6d6c"><td class="mdescLeft"> </td><td class="mdescRight">Shift in for EBDCDIC_STATEFUL and iso2022 states. <a href="#a082aba7f50746ff6135a4ca2a00f6d6c">More...</a><br /></td></tr>
<tr class="separator:a082aba7f50746ff6135a4ca2a00f6d6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3918524388c8100107273806bd58c65"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ad3918524388c8100107273806bd58c65">UCNV_SO</a>   0x0E</td></tr>
<tr class="memdesc:ad3918524388c8100107273806bd58c65"><td class="mdescLeft"> </td><td class="mdescRight">Shift out for EBDCDIC_STATEFUL and iso2022 states. <a href="#ad3918524388c8100107273806bd58c65">More...</a><br /></td></tr>
<tr class="separator:ad3918524388c8100107273806bd58c65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a420028eb5f83222307bf16632857b148"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a420028eb5f83222307bf16632857b148">UCNV_OPTION_SEP_CHAR</a>   ','</td></tr>
<tr class="memdesc:a420028eb5f83222307bf16632857b148"><td class="mdescLeft"> </td><td class="mdescRight">Character that separates converter names from options and options from each other. <a href="#a420028eb5f83222307bf16632857b148">More...</a><br /></td></tr>
<tr class="separator:a420028eb5f83222307bf16632857b148"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f221dc37208cc5c5e9b1d72a7103435"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a8f221dc37208cc5c5e9b1d72a7103435">UCNV_OPTION_SEP_STRING</a>   ","</td></tr>
<tr class="memdesc:a8f221dc37208cc5c5e9b1d72a7103435"><td class="mdescLeft"> </td><td class="mdescRight">String version of UCNV_OPTION_SEP_CHAR. <a href="#a8f221dc37208cc5c5e9b1d72a7103435">More...</a><br /></td></tr>
<tr class="separator:a8f221dc37208cc5c5e9b1d72a7103435"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92803b44385721ec771befc01b5e8e3b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a92803b44385721ec771befc01b5e8e3b">UCNV_VALUE_SEP_CHAR</a>   '='</td></tr>
<tr class="memdesc:a92803b44385721ec771befc01b5e8e3b"><td class="mdescLeft"> </td><td class="mdescRight">Character that separates a converter option from its value. <a href="#a92803b44385721ec771befc01b5e8e3b">More...</a><br /></td></tr>
<tr class="separator:a92803b44385721ec771befc01b5e8e3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33cd53c804d95e14388398843e6edc82"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a33cd53c804d95e14388398843e6edc82">UCNV_VALUE_SEP_STRING</a>   "="</td></tr>
<tr class="memdesc:a33cd53c804d95e14388398843e6edc82"><td class="mdescLeft"> </td><td class="mdescRight">String version of UCNV_VALUE_SEP_CHAR. <a href="#a33cd53c804d95e14388398843e6edc82">More...</a><br /></td></tr>
<tr class="separator:a33cd53c804d95e14388398843e6edc82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a867b3f44513565bca406eebe2f87ee99"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a867b3f44513565bca406eebe2f87ee99">UCNV_LOCALE_OPTION_STRING</a>   ",locale="</td></tr>
<tr class="memdesc:a867b3f44513565bca406eebe2f87ee99"><td class="mdescLeft"> </td><td class="mdescRight">Converter option for specifying a locale. <a href="#a867b3f44513565bca406eebe2f87ee99">More...</a><br /></td></tr>
<tr class="separator:a867b3f44513565bca406eebe2f87ee99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7b80fb72078403f8bdba322b63a5a93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ac7b80fb72078403f8bdba322b63a5a93">UCNV_VERSION_OPTION_STRING</a>   ",version="</td></tr>
<tr class="memdesc:ac7b80fb72078403f8bdba322b63a5a93"><td class="mdescLeft"> </td><td class="mdescRight">Converter option for specifying a version selector (0..9) for some converters. <a href="#ac7b80fb72078403f8bdba322b63a5a93">More...</a><br /></td></tr>
<tr class="separator:ac7b80fb72078403f8bdba322b63a5a93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0588f7014923ad969821941f9dd51040"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a0588f7014923ad969821941f9dd51040">UCNV_SWAP_LFNL_OPTION_STRING</a>   ",swaplfnl"</td></tr>
<tr class="memdesc:a0588f7014923ad969821941f9dd51040"><td class="mdescLeft"> </td><td class="mdescRight">Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages. <a href="#a0588f7014923ad969821941f9dd51040">More...</a><br /></td></tr>
<tr class="separator:a0588f7014923ad969821941f9dd51040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6ef5c3c7c83982313e415e697a26089"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ab6ef5c3c7c83982313e415e697a26089">U_CNV_SAFECLONE_BUFFERSIZE</a>   1024</td></tr>
<tr class="memdesc:ab6ef5c3c7c83982313e415e697a26089"><td class="mdescLeft"> </td><td class="mdescRight">Definition of a buffer size that is designed to be large enough for converters to be cloned with <a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e" title="Thread safe converter cloning operation. ">ucnv_safeClone()</a>. <a href="#ab6ef5c3c7c83982313e415e697a26089">More...</a><br /></td></tr>
<tr class="separator:ab6ef5c3c7c83982313e415e697a26089"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3d7e4ae84f8a95b9735ed3491cdb77e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aa3d7e4ae84f8a95b9735ed3491cdb77e">UCNV_GET_MAX_BYTES_FOR_STRING</a>(length, maxCharSize)   (((int32_t)(length)+10)*(int32_t)(maxCharSize))</td></tr>
<tr class="memdesc:aa3d7e4ae84f8a95b9735ed3491cdb77e"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the size of a buffer for conversion from Unicode to a charset. <a href="#aa3d7e4ae84f8a95b9735ed3491cdb77e">More...</a><br /></td></tr>
<tr class="separator:aa3d7e4ae84f8a95b9735ed3491cdb77e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:adce3fef7c15d7c78196bf977ac96ec9c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a></td></tr>
<tr class="separator:adce3fef7c15d7c78196bf977ac96ec9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92b936b684ecf81d0dc63229a27a7349"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a>) (const void *context, <a class="el" href="structUConverterToUnicodeArgs.html">UConverterToUnicodeArgs</a> *args, const char *codeUnits, int32_t length, <a class="el" href="ucnv__err_8h.html#a19e1a4d55a7679634e84b241b00de01a">UConverterCallbackReason</a> reason, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a92b936b684ecf81d0dc63229a27a7349"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for error callback in the codepage to unicode direction. <a href="#a92b936b684ecf81d0dc63229a27a7349">More...</a><br /></td></tr>
<tr class="separator:a92b936b684ecf81d0dc63229a27a7349"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9f3c1c236ab58bbc133783968f49750"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a>) (const void *context, <a class="el" href="structUConverterFromUnicodeArgs.html">UConverterFromUnicodeArgs</a> *args, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *codeUnits, int32_t length, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> codePoint, <a class="el" href="ucnv__err_8h.html#a19e1a4d55a7679634e84b241b00de01a">UConverterCallbackReason</a> reason, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:ad9f3c1c236ab58bbc133783968f49750"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for error callback in the unicode to codepage direction. <a href="#ad9f3c1c236ab58bbc133783968f49750">More...</a><br /></td></tr>
<tr class="separator:ad9f3c1c236ab58bbc133783968f49750"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6350e529c6de58338b006f7311e4e12"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#af6350e529c6de58338b006f7311e4e12">UConverterUnicodeSet</a></td></tr>
<tr class="memdesc:af6350e529c6de58338b006f7311e4e12"><td class="mdescLeft"> </td><td class="mdescRight">Selectors for Unicode sets that can be returned by <a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet()</a>. <a href="#af6350e529c6de58338b006f7311e4e12">More...</a><br /></td></tr>
<tr class="separator:af6350e529c6de58338b006f7311e4e12"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:adb0b44c6bd828c9d4cc2defcbba0f902"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> { <br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a8ba1940e34a58186b231679da1272904">UCNV_UNSUPPORTED_CONVERTER</a> = -1,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a81e595b85ba86dd7fde25f2a1c59bfc3">UCNV_SBCS</a> = 0,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902af7ed8ed108be1286bd0e01818dae0dbd">UCNV_DBCS</a> = 1,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ac0f17aec1772eeca6c86d13191b6c852">UCNV_MBCS</a> = 2,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a1211937ef4e044d96014a77c04915554">UCNV_LATIN_1</a> = 3,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a6a63fa949b29c7a55cc7cf5eecc3c89e">UCNV_UTF8</a> = 4,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aac97a8806bad1e28965f045cdbd8e305">UCNV_UTF16_BigEndian</a> = 5,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a824cb728f9beb71051820f49f74fa4dd">UCNV_UTF16_LittleEndian</a> = 6,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a1c8fa4af063d027b5bc2baa03bc29da8">UCNV_UTF32_BigEndian</a> = 7,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aa776a4cccf14778c20230da58aa1c38d">UCNV_UTF32_LittleEndian</a> = 8,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ab5b73d6ee548bda138fc56829800111b">UCNV_EBCDIC_STATEFUL</a> = 9,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a11368f51e102406facd6da0a3ee7d606">UCNV_ISO_2022</a> = 10,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902af2c460935eca00105ad7dc2622d74100">UCNV_LMBCS_1</a> = 11,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aaafb05c0fda0e6530807fedabf82c261">UCNV_LMBCS_2</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a6020a8e2cc71c9f8d8a64d729db9adb2">UCNV_LMBCS_3</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ac71afd7dc6b8a304638e52f8a8bed20b">UCNV_LMBCS_4</a>,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ab126f5ee7a9c722ed0425973cea76df3">UCNV_LMBCS_5</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a443a68687c6c38b7d683fa4070a953bd">UCNV_LMBCS_6</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aa8001a5fc7d37fa386c3d147106a6a5e">UCNV_LMBCS_8</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a0be612a93cffc67fc042b1bc168ed205">UCNV_LMBCS_11</a>,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a98bc32e41e4d6e7bd75275c7f9738113">UCNV_LMBCS_16</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a41ffccf0b679631558a2547d2e445cea">UCNV_LMBCS_17</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ad7a7305473e98bb7a9b4bf1f23406599">UCNV_LMBCS_18</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a16ff6cda2e1211eceadda889dbb359ba">UCNV_LMBCS_19</a>,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aee49b0c0e4b4fc4eb16627fce1620938">UCNV_LMBCS_LAST</a> = UCNV_LMBCS_19,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a086920821721b34d9260723ec86d5a71">UCNV_HZ</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ace8cd9e435b4a5579286931a57c0bd88">UCNV_SCSU</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a59030fe051a4961ab474d0d91017ad47">UCNV_ISCII</a>,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aaadc5fba9e00621313dd6c9a5be3a84d">UCNV_US_ASCII</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902ad4a8edc0956f24d724441118a8f2226c">UCNV_UTF7</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902add63c4e0987f7622db1f2c2052dd7da8">UCNV_BOCU1</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902aab2340e8dc51c36dd8f0b48b07ac82c1">UCNV_UTF16</a>,
<br />
  <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a4eed53e3582d767aa03cd3ba3828515f">UCNV_UTF32</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902afceba4bdab9c135cccabc255e580980b">UCNV_CESU8</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a690c232e8a75021df389c39f03869d26">UCNV_IMAP_MAILBOX</a>,
<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902a15555ec1e53dfa419dc6231f326ef79d">UCNV_COMPOUND_TEXT</a>,
<br />
  <b>UCNV_NUMBER_OF_SUPPORTED_CONVERTER_TYPES</b>
<br />
}<tr class="memdesc:adb0b44c6bd828c9d4cc2defcbba0f902"><td class="mdescLeft"> </td><td class="mdescRight">Enum for specifying basic types of converters. <a href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adb0b44c6bd828c9d4cc2defcbba0f902"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba5ba7fbc2f113618ba57f4d9825ff85"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a> { <b>UCNV_UNKNOWN</b> = -1,
<b>UCNV_IBM</b> = 0
}<tr class="memdesc:aba5ba7fbc2f113618ba57f4d9825ff85"><td class="mdescLeft"> </td><td class="mdescRight">Enum for specifying which platform a converter ID refers to. <a href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aba5ba7fbc2f113618ba57f4d9825ff85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a402221896b6d7153b14a5ff8dadde806"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> { <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806ab08c09dd129a92d08725b5260b49cbf9">UCNV_ROUNDTRIP_SET</a>,
<a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806a38d95100b8b58d2c66c4c83b30d99499">UCNV_ROUNDTRIP_AND_FALLBACK_SET</a>,
<a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806a33cced69d47e6de3cbfd79d17f88fcaf">UCNV_SET_COUNT</a>
}<tr class="memdesc:a402221896b6d7153b14a5ff8dadde806"><td class="mdescLeft"> </td><td class="mdescRight">Selectors for Unicode sets that can be returned by <a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet()</a>. <a href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a402221896b6d7153b14a5ff8dadde806"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6f998746d8a8a8afd837f04dbb1ab64a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a6f998746d8a8a8afd837f04dbb1ab64a">ucnv_compareNames</a> (const char *name1, const char *name2)</td></tr>
<tr class="memdesc:a6f998746d8a8a8afd837f04dbb1ab64a"><td class="mdescLeft"> </td><td class="mdescRight">Do a fuzzy compare of two converter/alias names. <a href="#a6f998746d8a8a8afd837f04dbb1ab64a">More...</a><br /></td></tr>
<tr class="separator:a6f998746d8a8a8afd837f04dbb1ab64a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a485c78d4149165f504effa2287717e41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41">ucnv_open</a> (const char *converterName, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a485c78d4149165f504effa2287717e41"><td class="mdescLeft"> </td><td class="mdescRight">Creates a UConverter object with the name of a coded character set specified as a C string. <a href="#a485c78d4149165f504effa2287717e41">More...</a><br /></td></tr>
<tr class="separator:a485c78d4149165f504effa2287717e41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82e86d5341b39c543c269c70b8310f3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a82e86d5341b39c543c269c70b8310f3e">ucnv_openU</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *name, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a82e86d5341b39c543c269c70b8310f3e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a Unicode converter with the names specified as unicode string. <a href="#a82e86d5341b39c543c269c70b8310f3e">More...</a><br /></td></tr>
<tr class="separator:a82e86d5341b39c543c269c70b8310f3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9df0109e866c32078ab96fd2fe994b15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15">ucnv_openCCSID</a> (int32_t codepage, <a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a> platform, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a9df0109e866c32078ab96fd2fe994b15"><td class="mdescLeft"> </td><td class="mdescRight">Creates a UConverter object from a CCSID number and platform pair. <a href="#a9df0109e866c32078ab96fd2fe994b15">More...</a><br /></td></tr>
<tr class="separator:a9df0109e866c32078ab96fd2fe994b15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e3fc1e59ac1404120f242b8911cadbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a7e3fc1e59ac1404120f242b8911cadbb">ucnv_openPackage</a> (const char *packageName, const char *converterName, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="separator:a7e3fc1e59ac1404120f242b8911cadbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11a66c267dce12a78dac2690d983d69e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e">ucnv_safeClone</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, void *stackBuffer, int32_t *pBufferSize, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a11a66c267dce12a78dac2690d983d69e"><td class="mdescLeft"> </td><td class="mdescRight">Thread safe converter cloning operation. <a href="#a11a66c267dce12a78dac2690d983d69e">More...</a><br /></td></tr>
<tr class="separator:a11a66c267dce12a78dac2690d983d69e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1718689bf60724fdfa08c51aa0cc5ea0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0">ucnv_close</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:a1718689bf60724fdfa08c51aa0cc5ea0"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the unicode converter and releases resources associated with just this instance. <a href="#a1718689bf60724fdfa08c51aa0cc5ea0">More...</a><br /></td></tr>
<tr class="separator:a1718689bf60724fdfa08c51aa0cc5ea0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a118a87477ffa827d00dd50727da02e31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a118a87477ffa827d00dd50727da02e31">ucnv_getSubstChars</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, char *subChars, int8_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a118a87477ffa827d00dd50727da02e31"><td class="mdescLeft"> </td><td class="mdescRight">Fills in the output parameter, subChars, with the substitution characters as multiple bytes. <a href="#a118a87477ffa827d00dd50727da02e31">More...</a><br /></td></tr>
<tr class="separator:a118a87477ffa827d00dd50727da02e31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac160b1b44ac9b5124ec083810709603a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ac160b1b44ac9b5124ec083810709603a">ucnv_setSubstChars</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, const char *subChars, int8_t len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:ac160b1b44ac9b5124ec083810709603a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the substitution chars when converting from unicode to a codepage. <a href="#ac160b1b44ac9b5124ec083810709603a">More...</a><br /></td></tr>
<tr class="separator:ac160b1b44ac9b5124ec083810709603a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af87333c550d699794ab84151ed9007c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#af87333c550d699794ab84151ed9007c6">ucnv_setSubstString</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *s, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:af87333c550d699794ab84151ed9007c6"><td class="mdescLeft"> </td><td class="mdescRight">Set a substitution string for converting from Unicode to a charset. <a href="#af87333c550d699794ab84151ed9007c6">More...</a><br /></td></tr>
<tr class="separator:af87333c550d699794ab84151ed9007c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8c925ce8f47ab08c53f9e3b3b9664f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ae8c925ce8f47ab08c53f9e3b3b9664f4">ucnv_getInvalidChars</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, char *errBytes, int8_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:ae8c925ce8f47ab08c53f9e3b3b9664f4"><td class="mdescLeft"> </td><td class="mdescRight">Fills in the output parameter, errBytes, with the error characters from the last failing conversion. <a href="#ae8c925ce8f47ab08c53f9e3b3b9664f4">More...</a><br /></td></tr>
<tr class="separator:ae8c925ce8f47ab08c53f9e3b3b9664f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a341f4716c12e62d24cc8431eb9dfecdd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a341f4716c12e62d24cc8431eb9dfecdd">ucnv_getInvalidUChars</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *errUChars, int8_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a341f4716c12e62d24cc8431eb9dfecdd"><td class="mdescLeft"> </td><td class="mdescRight">Fills in the output parameter, errChars, with the error characters from the last failing conversion. <a href="#a341f4716c12e62d24cc8431eb9dfecdd">More...</a><br /></td></tr>
<tr class="separator:a341f4716c12e62d24cc8431eb9dfecdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace43ec88f1615422f3c5c972ae79deba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ace43ec88f1615422f3c5c972ae79deba">ucnv_reset</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:ace43ec88f1615422f3c5c972ae79deba"><td class="mdescLeft"> </td><td class="mdescRight">Resets the state of a converter to the default state. <a href="#ace43ec88f1615422f3c5c972ae79deba">More...</a><br /></td></tr>
<tr class="separator:ace43ec88f1615422f3c5c972ae79deba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8711b61a6cd41d84cf522042b3aebaed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a8711b61a6cd41d84cf522042b3aebaed">ucnv_resetToUnicode</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:a8711b61a6cd41d84cf522042b3aebaed"><td class="mdescLeft"> </td><td class="mdescRight">Resets the to-Unicode part of a converter state to the default state. <a href="#a8711b61a6cd41d84cf522042b3aebaed">More...</a><br /></td></tr>
<tr class="separator:a8711b61a6cd41d84cf522042b3aebaed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8147239dca1fe5773de4905f2f74c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aba8147239dca1fe5773de4905f2f74c2">ucnv_resetFromUnicode</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:aba8147239dca1fe5773de4905f2f74c2"><td class="mdescLeft"> </td><td class="mdescRight">Resets the from-Unicode part of a converter state to the default state. <a href="#aba8147239dca1fe5773de4905f2f74c2">More...</a><br /></td></tr>
<tr class="separator:aba8147239dca1fe5773de4905f2f74c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11007a7bcc41b1030cda0ee28fe78195"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a11007a7bcc41b1030cda0ee28fe78195">ucnv_getMaxCharSize</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:a11007a7bcc41b1030cda0ee28fe78195"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this converter. <a href="#a11007a7bcc41b1030cda0ee28fe78195">More...</a><br /></td></tr>
<tr class="separator:a11007a7bcc41b1030cda0ee28fe78195"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12edd465a611c41e418632f5d5f2dbe4"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a12edd465a611c41e418632f5d5f2dbe4">ucnv_getMinCharSize</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:a12edd465a611c41e418632f5d5f2dbe4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the minimum byte length (per codepoint) for characters in this codepage. <a href="#a12edd465a611c41e418632f5d5f2dbe4">More...</a><br /></td></tr>
<tr class="separator:a12edd465a611c41e418632f5d5f2dbe4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36c33bb6459c126f64e5472c6e5023a6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a36c33bb6459c126f64e5472c6e5023a6">ucnv_getDisplayName</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, const char *displayLocale, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *displayName, int32_t displayNameCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a36c33bb6459c126f64e5472c6e5023a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the display name of the converter passed in based on the Locale passed in. <a href="#a36c33bb6459c126f64e5472c6e5023a6">More...</a><br /></td></tr>
<tr class="separator:a36c33bb6459c126f64e5472c6e5023a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac2e332117c919a01516c726c051dd55"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aac2e332117c919a01516c726c051dd55">ucnv_getName</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:aac2e332117c919a01516c726c051dd55"><td class="mdescLeft"> </td><td class="mdescRight">Gets the internal, canonical name of the converter (zero-terminated). <a href="#aac2e332117c919a01516c726c051dd55">More...</a><br /></td></tr>
<tr class="separator:aac2e332117c919a01516c726c051dd55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0500738a0f4a552725725f9fe964e430"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a0500738a0f4a552725725f9fe964e430">ucnv_getCCSID</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a0500738a0f4a552725725f9fe964e430"><td class="mdescLeft"> </td><td class="mdescRight">Gets a codepage number associated with the converter. <a href="#a0500738a0f4a552725725f9fe964e430">More...</a><br /></td></tr>
<tr class="separator:a0500738a0f4a552725725f9fe964e430"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa14f20f0ffa7f602690956cf3a5c87e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aa14f20f0ffa7f602690956cf3a5c87e2">ucnv_getPlatform</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:aa14f20f0ffa7f602690956cf3a5c87e2"><td class="mdescLeft"> </td><td class="mdescRight">Gets a codepage platform associated with the converter. <a href="#aa14f20f0ffa7f602690956cf3a5c87e2">More...</a><br /></td></tr>
<tr class="separator:aa14f20f0ffa7f602690956cf3a5c87e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94a8af5dd3516cea50c2829e6c35b397"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a94a8af5dd3516cea50c2829e6c35b397">ucnv_getType</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter)</td></tr>
<tr class="memdesc:a94a8af5dd3516cea50c2829e6c35b397"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the converter e.g. <a href="#a94a8af5dd3516cea50c2829e6c35b397">More...</a><br /></td></tr>
<tr class="separator:a94a8af5dd3516cea50c2829e6c35b397"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa970dda00a55c1751b7fe0bb34b04015"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aa970dda00a55c1751b7fe0bb34b04015">ucnv_getStarters</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> starters[256], <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:aa970dda00a55c1751b7fe0bb34b04015"><td class="mdescLeft"> </td><td class="mdescRight">Gets the "starter" (lead) bytes for converters of type MBCS. <a href="#aa970dda00a55c1751b7fe0bb34b04015">More...</a><br /></td></tr>
<tr class="separator:aa970dda00a55c1751b7fe0bb34b04015"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec7c273c8ce917ff75224e25914c53be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be">ucnv_getUnicodeSet</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *setFillIn, <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> whichSet, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:aec7c273c8ce917ff75224e25914c53be"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of Unicode code points that can be converted by an ICU converter. <a href="#aec7c273c8ce917ff75224e25914c53be">More...</a><br /></td></tr>
<tr class="separator:aec7c273c8ce917ff75224e25914c53be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af45faec39053767f4a7a779586c24223"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#af45faec39053767f4a7a779586c24223">ucnv_getToUCallBack</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> *action, const void **context)</td></tr>
<tr class="memdesc:af45faec39053767f4a7a779586c24223"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current calback function used by the converter when an illegal or invalid codepage sequence is found. <a href="#af45faec39053767f4a7a779586c24223">More...</a><br /></td></tr>
<tr class="separator:af45faec39053767f4a7a779586c24223"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a2dcbf10e3b08a97ed0b06466d9e8a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a2a2dcbf10e3b08a97ed0b06466d9e8a5">ucnv_getFromUCallBack</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> *action, const void **context)</td></tr>
<tr class="memdesc:a2a2dcbf10e3b08a97ed0b06466d9e8a5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current callback function used by the converter when illegal or invalid Unicode sequence is found. <a href="#a2a2dcbf10e3b08a97ed0b06466d9e8a5">More...</a><br /></td></tr>
<tr class="separator:a2a2dcbf10e3b08a97ed0b06466d9e8a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1f96fe9de8e2ee39159f748a8d33a4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ab1f96fe9de8e2ee39159f748a8d33a4b">ucnv_setToUCallBack</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> newAction, const void *newContext, <a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> *oldAction, const void **oldContext, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:ab1f96fe9de8e2ee39159f748a8d33a4b"><td class="mdescLeft"> </td><td class="mdescRight">Changes the callback function used by the converter when an illegal or invalid sequence is found. <a href="#ab1f96fe9de8e2ee39159f748a8d33a4b">More...</a><br /></td></tr>
<tr class="separator:ab1f96fe9de8e2ee39159f748a8d33a4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59fdaf2cf5dc57d738ed7a7657f6b03a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a59fdaf2cf5dc57d738ed7a7657f6b03a">ucnv_setFromUCallBack</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> newAction, const void *newContext, <a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> *oldAction, const void **oldContext, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a59fdaf2cf5dc57d738ed7a7657f6b03a"><td class="mdescLeft"> </td><td class="mdescRight">Changes the current callback function used by the converter when an illegal or invalid sequence is found. <a href="#a59fdaf2cf5dc57d738ed7a7657f6b03a">More...</a><br /></td></tr>
<tr class="separator:a59fdaf2cf5dc57d738ed7a7657f6b03a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a1f09772549fbcd7dd782297212c19f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f">ucnv_fromUnicode</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, char **target, const char *targetLimit, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> **source, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *sourceLimit, int32_t *offsets, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> flush, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:a4a1f09772549fbcd7dd782297212c19f"><td class="mdescLeft"> </td><td class="mdescRight">Converts an array of unicode characters to an array of codepage characters. <a href="#a4a1f09772549fbcd7dd782297212c19f">More...</a><br /></td></tr>
<tr class="separator:a4a1f09772549fbcd7dd782297212c19f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbea5eb35a5ec1517a548ffc868a5599"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599">ucnv_toUnicode</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> **target, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *targetLimit, const char **source, const char *sourceLimit, int32_t *offsets, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> flush, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:afbea5eb35a5ec1517a548ffc868a5599"><td class="mdescLeft"> </td><td class="mdescRight">Converts a buffer of codepage bytes into an array of unicode UChars characters. <a href="#afbea5eb35a5ec1517a548ffc868a5599">More...</a><br /></td></tr>
<tr class="separator:afbea5eb35a5ec1517a548ffc868a5599"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31bd5a5af440108a1a51bb0234ad32ac"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac">ucnv_fromUChars</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, char *dest, int32_t destCapacity, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *src, int32_t srcLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a31bd5a5af440108a1a51bb0234ad32ac"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string into a codepage string using an existing UConverter. <a href="#a31bd5a5af440108a1a51bb0234ad32ac">More...</a><br /></td></tr>
<tr class="separator:a31bd5a5af440108a1a51bb0234ad32ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1493c21231f237e6197c027229389ff8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8">ucnv_toUChars</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *dest, int32_t destCapacity, const char *src, int32_t srcLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a1493c21231f237e6197c027229389ff8"><td class="mdescLeft"> </td><td class="mdescRight">Convert the codepage string into a Unicode string using an existing UConverter. <a href="#a1493c21231f237e6197c027229389ff8">More...</a><br /></td></tr>
<tr class="separator:a1493c21231f237e6197c027229389ff8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf391b89870fd88b3da838eff1bd6ba6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6">ucnv_getNextUChar</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *converter, const char **source, const char *sourceLimit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr class="memdesc:aaf391b89870fd88b3da838eff1bd6ba6"><td class="mdescLeft"> </td><td class="mdescRight">Convert a codepage buffer into Unicode one character at a time. <a href="#aaf391b89870fd88b3da838eff1bd6ba6">More...</a><br /></td></tr>
<tr class="separator:aaf391b89870fd88b3da838eff1bd6ba6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4c967c5afa207d064c24e19256586b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6">ucnv_convertEx</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *targetCnv, <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *sourceCnv, char **target, const char *targetLimit, const char **source, const char *sourceLimit, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pivotStart, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> **pivotSource, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> **pivotTarget, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pivotLimit, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> reset, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> flush, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:af4c967c5afa207d064c24e19256586b6"><td class="mdescLeft"> </td><td class="mdescRight">Convert from one external charset to another using two existing UConverters. <a href="#af4c967c5afa207d064c24e19256586b6">More...</a><br /></td></tr>
<tr class="separator:af4c967c5afa207d064c24e19256586b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bdb6b1d3ac4069808348eb6961ce63d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d">ucnv_convert</a> (const char *toConverterName, const char *fromConverterName, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a2bdb6b1d3ac4069808348eb6961ce63d"><td class="mdescLeft"> </td><td class="mdescRight">Convert from one external charset to another. <a href="#a2bdb6b1d3ac4069808348eb6961ce63d">More...</a><br /></td></tr>
<tr class="separator:a2bdb6b1d3ac4069808348eb6961ce63d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b619c24f88f8b10f97b64ab1dc4fc86"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1b619c24f88f8b10f97b64ab1dc4fc86">ucnv_toAlgorithmic</a> (<a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> algorithmicType, <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a1b619c24f88f8b10f97b64ab1dc4fc86"><td class="mdescLeft"> </td><td class="mdescRight">Convert from one external charset to another. <a href="#a1b619c24f88f8b10f97b64ab1dc4fc86">More...</a><br /></td></tr>
<tr class="separator:a1b619c24f88f8b10f97b64ab1dc4fc86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cd24dc4d6c2fbec8c6481309459b7d5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5">ucnv_fromAlgorithmic</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> algorithmicType, char *target, int32_t targetCapacity, const char *source, int32_t sourceLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a5cd24dc4d6c2fbec8c6481309459b7d5"><td class="mdescLeft"> </td><td class="mdescRight">Convert from one external charset to another. <a href="#a5cd24dc4d6c2fbec8c6481309459b7d5">More...</a><br /></td></tr>
<tr class="separator:a5cd24dc4d6c2fbec8c6481309459b7d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0c427930c575dac20c0166ad4ef0986"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ab0c427930c575dac20c0166ad4ef0986">ucnv_flushCache</a> (void)</td></tr>
<tr class="memdesc:ab0c427930c575dac20c0166ad4ef0986"><td class="mdescLeft"> </td><td class="mdescRight">Frees up memory occupied by unused, cached converter shared data. <a href="#ab0c427930c575dac20c0166ad4ef0986">More...</a><br /></td></tr>
<tr class="separator:ab0c427930c575dac20c0166ad4ef0986"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50a330a3628673c9a6a7eb6be30b94ae"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a50a330a3628673c9a6a7eb6be30b94ae">ucnv_countAvailable</a> (void)</td></tr>
<tr class="memdesc:a50a330a3628673c9a6a7eb6be30b94ae"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of available converters, as per the alias file. <a href="#a50a330a3628673c9a6a7eb6be30b94ae">More...</a><br /></td></tr>
<tr class="separator:a50a330a3628673c9a6a7eb6be30b94ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22feff7d04fe7a9dc62d1f7ecb4eb647"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a22feff7d04fe7a9dc62d1f7ecb4eb647">ucnv_getAvailableName</a> (int32_t n)</td></tr>
<tr class="memdesc:a22feff7d04fe7a9dc62d1f7ecb4eb647"><td class="mdescLeft"> </td><td class="mdescRight">Gets the canonical converter name of the specified converter from a list of all available converters contaied in the alias file. <a href="#a22feff7d04fe7a9dc62d1f7ecb4eb647">More...</a><br /></td></tr>
<tr class="separator:a22feff7d04fe7a9dc62d1f7ecb4eb647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23282ab66962108aa8eba7096e4499ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a23282ab66962108aa8eba7096e4499ed">ucnv_openAllNames</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a23282ab66962108aa8eba7096e4499ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns a UEnumeration to enumerate all of the canonical converter names, as per the alias file, regardless of the ability to open each converter. <a href="#a23282ab66962108aa8eba7096e4499ed">More...</a><br /></td></tr>
<tr class="separator:a23282ab66962108aa8eba7096e4499ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3db46e3d4319ea85ebfde031e2e1bcb"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ab3db46e3d4319ea85ebfde031e2e1bcb">ucnv_countAliases</a> (const char *alias, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:ab3db46e3d4319ea85ebfde031e2e1bcb"><td class="mdescLeft"> </td><td class="mdescRight">Gives the number of aliases for a given converter or alias name. <a href="#ab3db46e3d4319ea85ebfde031e2e1bcb">More...</a><br /></td></tr>
<tr class="separator:ab3db46e3d4319ea85ebfde031e2e1bcb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a686d4e3d2905f3e2819577391fd08c2c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a686d4e3d2905f3e2819577391fd08c2c">ucnv_getAlias</a> (const char *alias, uint16_t n, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a686d4e3d2905f3e2819577391fd08c2c"><td class="mdescLeft"> </td><td class="mdescRight">Gives the name of the alias at given index of alias list. <a href="#a686d4e3d2905f3e2819577391fd08c2c">More...</a><br /></td></tr>
<tr class="separator:a686d4e3d2905f3e2819577391fd08c2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae16a53f19829be2f5227d0259e3120eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ae16a53f19829be2f5227d0259e3120eb">ucnv_getAliases</a> (const char *alias, const char **aliases, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:ae16a53f19829be2f5227d0259e3120eb"><td class="mdescLeft"> </td><td class="mdescRight">Fill-up the list of alias names for the given alias. <a href="#ae16a53f19829be2f5227d0259e3120eb">More...</a><br /></td></tr>
<tr class="separator:ae16a53f19829be2f5227d0259e3120eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6901c3ca8e871ef1efaa14d7f653d40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ab6901c3ca8e871ef1efaa14d7f653d40">ucnv_openStandardNames</a> (const char *convName, const char *standard, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:ab6901c3ca8e871ef1efaa14d7f653d40"><td class="mdescLeft"> </td><td class="mdescRight">Return a new UEnumeration object for enumerating all the alias names for a given converter that are recognized by a standard. <a href="#ab6901c3ca8e871ef1efaa14d7f653d40">More...</a><br /></td></tr>
<tr class="separator:ab6901c3ca8e871ef1efaa14d7f653d40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78bdc2c475baff8029a6a9782b862384"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a78bdc2c475baff8029a6a9782b862384">ucnv_countStandards</a> (void)</td></tr>
<tr class="memdesc:a78bdc2c475baff8029a6a9782b862384"><td class="mdescLeft"> </td><td class="mdescRight">Gives the number of standards associated to converter names. <a href="#a78bdc2c475baff8029a6a9782b862384">More...</a><br /></td></tr>
<tr class="separator:a78bdc2c475baff8029a6a9782b862384"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96c90729859689a2ae7c29f3f7f1306a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a96c90729859689a2ae7c29f3f7f1306a">ucnv_getStandard</a> (uint16_t n, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a96c90729859689a2ae7c29f3f7f1306a"><td class="mdescLeft"> </td><td class="mdescRight">Gives the name of the standard at given index of standard list. <a href="#a96c90729859689a2ae7c29f3f7f1306a">More...</a><br /></td></tr>
<tr class="separator:a96c90729859689a2ae7c29f3f7f1306a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e1030c73ab423ec40b7b947320936c2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a2e1030c73ab423ec40b7b947320936c2">ucnv_getStandardName</a> (const char *name, const char *standard, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a2e1030c73ab423ec40b7b947320936c2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a standard name for a given converter name. <a href="#a2e1030c73ab423ec40b7b947320936c2">More...</a><br /></td></tr>
<tr class="separator:a2e1030c73ab423ec40b7b947320936c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1601f0d125e4b695ad1f84d6db441e6e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1601f0d125e4b695ad1f84d6db441e6e">ucnv_getCanonicalName</a> (const char *alias, const char *standard, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a1601f0d125e4b695ad1f84d6db441e6e"><td class="mdescLeft"> </td><td class="mdescRight">This function will return the internal canonical converter name of the tagged alias. <a href="#a1601f0d125e4b695ad1f84d6db441e6e">More...</a><br /></td></tr>
<tr class="separator:a1601f0d125e4b695ad1f84d6db441e6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a611d8da795489692511b07525a2f8b95"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a611d8da795489692511b07525a2f8b95">ucnv_getDefaultName</a> (void)</td></tr>
<tr class="memdesc:a611d8da795489692511b07525a2f8b95"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current default converter name. <a href="#a611d8da795489692511b07525a2f8b95">More...</a><br /></td></tr>
<tr class="separator:a611d8da795489692511b07525a2f8b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a2aaa1bd664b8b53da8cb50f1025bf9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1a2aaa1bd664b8b53da8cb50f1025bf9">ucnv_setDefaultName</a> (const char *name)</td></tr>
<tr class="memdesc:a1a2aaa1bd664b8b53da8cb50f1025bf9"><td class="mdescLeft"> </td><td class="mdescRight">This function is not thread safe. <a href="#a1a2aaa1bd664b8b53da8cb50f1025bf9">More...</a><br /></td></tr>
<tr class="separator:a1a2aaa1bd664b8b53da8cb50f1025bf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2962e5b30828db79345b5250cf411f90"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a2962e5b30828db79345b5250cf411f90">ucnv_fixFileSeparator</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLen)</td></tr>
<tr class="memdesc:a2962e5b30828db79345b5250cf411f90"><td class="mdescLeft"> </td><td class="mdescRight">Fixes the backslash character mismapping. <a href="#a2962e5b30828db79345b5250cf411f90">More...</a><br /></td></tr>
<tr class="separator:a2962e5b30828db79345b5250cf411f90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac38aa0a9daa58ca49dda17b2b7d40b8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ac38aa0a9daa58ca49dda17b2b7d40b8c">ucnv_isAmbiguous</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv)</td></tr>
<tr class="memdesc:ac38aa0a9daa58ca49dda17b2b7d40b8c"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the converter contains ambiguous mappings of the same character or not. <a href="#ac38aa0a9daa58ca49dda17b2b7d40b8c">More...</a><br /></td></tr>
<tr class="separator:ac38aa0a9daa58ca49dda17b2b7d40b8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117c45b5c1d746c6f532f44985b686e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a117c45b5c1d746c6f532f44985b686e4">ucnv_setFallback</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> usesFallback)</td></tr>
<tr class="memdesc:a117c45b5c1d746c6f532f44985b686e4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the converter to use fallback mappings or not. <a href="#a117c45b5c1d746c6f532f44985b686e4">More...</a><br /></td></tr>
<tr class="separator:a117c45b5c1d746c6f532f44985b686e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a036433918c08965c4c687892036db3eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a036433918c08965c4c687892036db3eb">ucnv_usesFallback</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv)</td></tr>
<tr class="memdesc:a036433918c08965c4c687892036db3eb"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the converter uses fallback mappings or not. <a href="#a036433918c08965c4c687892036db3eb">More...</a><br /></td></tr>
<tr class="separator:a036433918c08965c4c687892036db3eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad43176e199992be4069b67177ce6d3ce"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#ad43176e199992be4069b67177ce6d3ce">ucnv_detectUnicodeSignature</a> (const char *source, int32_t sourceLength, int32_t *signatureLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:ad43176e199992be4069b67177ce6d3ce"><td class="mdescLeft"> </td><td class="mdescRight">Detects Unicode signature byte sequences at the start of the byte stream and returns the charset name of the indicated Unicode charset. <a href="#ad43176e199992be4069b67177ce6d3ce">More...</a><br /></td></tr>
<tr class="separator:ad43176e199992be4069b67177ce6d3ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d848a6a75fc14c38485ecd908694ac0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a1d848a6a75fc14c38485ecd908694ac0">ucnv_fromUCountPending</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1d848a6a75fc14c38485ecd908694ac0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of UChars held in the converter's internal state because more input is needed for completing the conversion. <a href="#a1d848a6a75fc14c38485ecd908694ac0">More...</a><br /></td></tr>
<tr class="separator:a1d848a6a75fc14c38485ecd908694ac0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a607e2305f45490a01fd8a32261e32e0c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a607e2305f45490a01fd8a32261e32e0c">ucnv_toUCountPending</a> (const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a607e2305f45490a01fd8a32261e32e0c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of chars held in the converter's internal state because more input is needed for completing the conversion. <a href="#a607e2305f45490a01fd8a32261e32e0c">More...</a><br /></td></tr>
<tr class="separator:a607e2305f45490a01fd8a32261e32e0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dde59e660b06fe6a47cc55b38e0a68e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnv_8h.html#a7dde59e660b06fe6a47cc55b38e0a68e">ucnv_isFixedWidth</a> (<a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a7dde59e660b06fe6a47cc55b38e0a68e"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the charset of the converter has a fixed number of bytes per charset character. <a href="#a7dde59e660b06fe6a47cc55b38e0a68e">More...</a><br /></td></tr>
<tr class="separator:a7dde59e660b06fe6a47cc55b38e0a68e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: Character conversion. </p>
<h2>Character Conversion C API</h2>
<p>This API is used to convert codepage or character encoded data to and from UTF-16. You can open a converter with <a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41">ucnv_open()</a>. With that converter, you can get its properties, set options, convert your data and close the converter.</p>
<p>Since many software programs recogize different converter names for different types of converters, there are other functions in this API to iterate over the converter aliases. The functions <a class="el" href="ucnv_8h.html#a22feff7d04fe7a9dc62d1f7ecb4eb647">ucnv_getAvailableName()</a>, <a class="el" href="ucnv_8h.html#a686d4e3d2905f3e2819577391fd08c2c">ucnv_getAlias()</a> and <a class="el" href="ucnv_8h.html#a2e1030c73ab423ec40b7b947320936c2">ucnv_getStandardName()</a> are some of the more frequently used alias functions to get this information.</p>
<p>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 <a class="el" href="ucnv_8h.html#a59fdaf2cf5dc57d738ed7a7657f6b03a">ucnv_setFromUCallBack()</a> or <a class="el" href="ucnv_8h.html#ab1f96fe9de8e2ee39159f748a8d33a4b">ucnv_setToUCallBack()</a> on the converter. The header <a class="el" href="ucnv__err_8h.html" title="C UConverter predefined error callbacks. ">ucnv_err.h</a> defines many other callback actions that can be used instead of a character substitution.</p>
<p>More information about this API can be found in our <a href="http://icu-project.org/userguide/conversion.html">User's Guide</a>.</p>
<p>Definition in file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ab6ef5c3c7c83982313e415e697a26089"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_CNV_SAFECLONE_BUFFERSIZE   1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition of a buffer size that is designed to be large enough for converters to be cloned with <a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e" title="Thread safe converter cloning operation. ">ucnv_safeClone()</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000081">Deprecated:</a></b></dt><dd>ICU 52. Do not rely on <a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e" title="Thread safe converter cloning operation. ">ucnv_safeClone()</a> cloning into any provided buffer. </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00555">555</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3d7e4ae84f8a95b9735ed3491cdb77e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_GET_MAX_BYTES_FOR_STRING</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">length, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">maxCharSize </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (((int32_t)(length)+10)*(int32_t)(maxCharSize))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the size of a buffer for conversion from Unicode to a charset. </p>
<p>The calculated size is guaranteed to be sufficient for this conversion.</p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>Number of UChars to be converted. </td></tr>
<tr><td class="paramname">maxCharSize</td><td>Return value from <a class="el" href="ucnv_8h.html#a11007a7bcc41b1030cda0ee28fe78195" title="Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this c...">ucnv_getMaxCharSize()</a> for the converter that will be used. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>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.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a11007a7bcc41b1030cda0ee28fe78195" title="Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this c...">ucnv_getMaxCharSize</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001499">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00815">815</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a867b3f44513565bca406eebe2f87ee99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_LOCALE_OPTION_STRING   ",locale="</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converter option for specifying a locale. </p>
<p>For example, ucnv_open("SCSU,locale=ja", &errorCode); See convrtrs.txt.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001480">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00270">270</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3ab00bb423db8533da12c35848e4c281"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_MAX_CONVERTER_NAME_LENGTH   60</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum length of a converter name including the terminating NULL. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001468">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00078">78</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1a579f67d05b09f731df5a68eb80b851"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_MAX_FULL_FILE_NAME_LENGTH   (600+<a class="el" href="ucnv_8h.html#a3ab00bb423db8533da12c35848e4c281">UCNV_MAX_CONVERTER_NAME_LENGTH</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum length of a converter name including path and terminating NULL. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001469">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00080">80</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a420028eb5f83222307bf16632857b148"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_OPTION_SEP_CHAR   ','</td>
</tr>
</table>
</div><div class="memdoc">
<p>Character that separates converter names from options and options from each other. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001476">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00239">239</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8f221dc37208cc5c5e9b1d72a7103435"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_OPTION_SEP_STRING   ","</td>
</tr>
</table>
</div><div class="memdoc">
<p>String version of UCNV_OPTION_SEP_CHAR. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001477">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00246">246</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a082aba7f50746ff6135a4ca2a00f6d6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_SI   0x0F</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shift in for EBDCDIC_STATEFUL and iso2022 states. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001470">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00083">83</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad3918524388c8100107273806bd58c65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_SO   0x0E</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shift out for EBDCDIC_STATEFUL and iso2022 states. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001471">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00085">85</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0588f7014923ad969821941f9dd51040"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_SWAP_LFNL_OPTION_STRING   ",swaplfnl"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages. </p>
<p>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.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001482">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00295">295</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a92803b44385721ec771befc01b5e8e3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_VALUE_SEP_CHAR   '='</td>
</tr>
</table>
</div><div class="memdoc">
<p>Character that separates a converter option from its value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001478">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00253">253</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a33cd53c804d95e14388398843e6edc82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_VALUE_SEP_STRING   "="</td>
</tr>
</table>
</div><div class="memdoc">
<p>String version of UCNV_VALUE_SEP_CHAR. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001479">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00260">260</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac7b80fb72078403f8bdba322b63a5a93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCNV_VERSION_OPTION_STRING   ",version="</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converter option for specifying a version selector (0..9) for some converters. </p>
<p>For example, </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> ucnv_open("UTF-7,version=1", &errorCode);</div></div><!-- fragment --><p> See convrtrs.txt.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001481">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00283">283</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ad9f3c1c236ab58bbc133783968f49750"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void( * UConverterFromUCallback) (const void *context, <a class="el" href="structUConverterFromUnicodeArgs.html">UConverterFromUnicodeArgs</a> *args, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *codeUnits, int32_t length, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> codePoint, <a class="el" href="ucnv__err_8h.html#a19e1a4d55a7679634e84b241b00de01a">UConverterCallbackReason</a> reason, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function pointer for error callback in the unicode to codepage direction. </p>
<p>Called when an error has occured in conversion from unicode, or on open/close of the callback (see reason). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>Pointer to the callback's private data </td></tr>
<tr><td class="paramname">args</td><td>Information about the conversion in progress </td></tr>
<tr><td class="paramname">codeUnits</td><td>Points to 'length' UChars of the concerned Unicode sequence </td></tr>
<tr><td class="paramname">length</td><td>Size (in bytes) of the concerned codepage sequence </td></tr>
<tr><td class="paramname">codePoint</td><td>Single UChar32 (UTF-32) containing the concerend Unicode codepoint. </td></tr>
<tr><td class="paramname">reason</td><td>Defines the reason the callback was invoked </td></tr>
<tr><td class="paramname">pErrorCode</td><td>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. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a59fdaf2cf5dc57d738ed7a7657f6b03a" title="Changes the current callback function used by the converter when an illegal or invalid sequence is fo...">ucnv_setFromUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001475">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00223">223</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a92b936b684ecf81d0dc63229a27a7349"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void( * UConverterToUCallback) (const void *context, <a class="el" href="structUConverterToUnicodeArgs.html">UConverterToUnicodeArgs</a> *args, const char *codeUnits, int32_t length, <a class="el" href="ucnv__err_8h.html#a19e1a4d55a7679634e84b241b00de01a">UConverterCallbackReason</a> reason, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function pointer for error callback in the codepage to unicode direction. </p>
<p>Called when an error has occured in conversion to unicode, or on open/close of the callback (see reason). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>Pointer to the callback's private data </td></tr>
<tr><td class="paramname">args</td><td>Information about the conversion in progress </td></tr>
<tr><td class="paramname">codeUnits</td><td>Points to 'length' bytes of the concerned codepage sequence </td></tr>
<tr><td class="paramname">length</td><td>Size (in bytes) of the concerned codepage sequence </td></tr>
<tr><td class="paramname">reason</td><td>Defines the reason the callback was invoked </td></tr>
<tr><td class="paramname">pErrorCode</td><td>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. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#ab1f96fe9de8e2ee39159f748a8d33a4b" title="Changes the callback function used by the converter when an illegal or invalid sequence is found...">ucnv_setToUCallBack</a> </dd>
<dd>
<a class="el" href="structUConverterToUnicodeArgs.html" title="The structure for the toUnicode callback function parameter. ">UConverterToUnicodeArgs</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001474">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00200">200</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="af6350e529c6de58338b006f7311e4e12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selectors for Unicode sets that can be returned by <a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet()</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001507">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="adce3fef7c15d7c78196bf977ac96ec9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001467">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00069">69</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="aba5ba7fbc2f113618ba57f4d9825ff85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for specifying which platform a converter ID refers to. </p>
<p>The use of platform/CCSID is not recommended. See <a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#aa14f20f0ffa7f602690956cf3a5c87e2" title="Gets a codepage platform associated with the converter. ">ucnv_getPlatform</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a0500738a0f4a552725725f9fe964e430" title="Gets a codepage number associated with the converter. ">ucnv_getCCSID</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001473">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00180">180</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for specifying basic types of converters. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a94a8af5dd3516cea50c2829e6c35b397" title="Gets the type of the converter e.g. ">ucnv_getType</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001472">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a8ba1940e34a58186b231679da1272904"></a>UCNV_UNSUPPORTED_CONVERTER </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001544">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a81e595b85ba86dd7fde25f2a1c59bfc3"></a>UCNV_SBCS </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001545">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902af7ed8ed108be1286bd0e01818dae0dbd"></a>UCNV_DBCS </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001546">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ac0f17aec1772eeca6c86d13191b6c852"></a>UCNV_MBCS </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001547">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a1211937ef4e044d96014a77c04915554"></a>UCNV_LATIN_1 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001548">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a6a63fa949b29c7a55cc7cf5eecc3c89e"></a>UCNV_UTF8 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001549">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aac97a8806bad1e28965f045cdbd8e305"></a>UCNV_UTF16_BigEndian </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001550">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a824cb728f9beb71051820f49f74fa4dd"></a>UCNV_UTF16_LittleEndian </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001551">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a1c8fa4af063d027b5bc2baa03bc29da8"></a>UCNV_UTF32_BigEndian </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001552">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aa776a4cccf14778c20230da58aa1c38d"></a>UCNV_UTF32_LittleEndian </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001553">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ab5b73d6ee548bda138fc56829800111b"></a>UCNV_EBCDIC_STATEFUL </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001554">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a11368f51e102406facd6da0a3ee7d606"></a>UCNV_ISO_2022 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001555">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902af2c460935eca00105ad7dc2622d74100"></a>UCNV_LMBCS_1 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001556">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aaafb05c0fda0e6530807fedabf82c261"></a>UCNV_LMBCS_2 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001557">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a6020a8e2cc71c9f8d8a64d729db9adb2"></a>UCNV_LMBCS_3 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001558">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ac71afd7dc6b8a304638e52f8a8bed20b"></a>UCNV_LMBCS_4 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001559">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ab126f5ee7a9c722ed0425973cea76df3"></a>UCNV_LMBCS_5 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001560">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a443a68687c6c38b7d683fa4070a953bd"></a>UCNV_LMBCS_6 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001561">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aa8001a5fc7d37fa386c3d147106a6a5e"></a>UCNV_LMBCS_8 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001562">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a0be612a93cffc67fc042b1bc168ed205"></a>UCNV_LMBCS_11 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001563">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a98bc32e41e4d6e7bd75275c7f9738113"></a>UCNV_LMBCS_16 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001564">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a41ffccf0b679631558a2547d2e445cea"></a>UCNV_LMBCS_17 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001565">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ad7a7305473e98bb7a9b4bf1f23406599"></a>UCNV_LMBCS_18 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001566">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a16ff6cda2e1211eceadda889dbb359ba"></a>UCNV_LMBCS_19 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001567">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aee49b0c0e4b4fc4eb16627fce1620938"></a>UCNV_LMBCS_LAST </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001568">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a086920821721b34d9260723ec86d5a71"></a>UCNV_HZ </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001569">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ace8cd9e435b4a5579286931a57c0bd88"></a>UCNV_SCSU </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001570">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a59030fe051a4961ab474d0d91017ad47"></a>UCNV_ISCII </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001571">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aaadc5fba9e00621313dd6c9a5be3a84d"></a>UCNV_US_ASCII </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001572">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902ad4a8edc0956f24d724441118a8f2226c"></a>UCNV_UTF7 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001573">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902add63c4e0987f7622db1f2c2052dd7da8"></a>UCNV_BOCU1 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001574">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902aab2340e8dc51c36dd8f0b48b07ac82c1"></a>UCNV_UTF16 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001575">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a4eed53e3582d767aa03cd3ba3828515f"></a>UCNV_UTF32 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001576">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902afceba4bdab9c135cccabc255e580980b"></a>UCNV_CESU8 </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001577">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a690c232e8a75021df389c39f03869d26"></a>UCNV_IMAP_MAILBOX </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001578">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="adb0b44c6bd828c9d4cc2defcbba0f902a15555ec1e53dfa419dc6231f326ef79d"></a>UCNV_COMPOUND_TEXT </td><td class="fielddoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001579">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00092">92</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<a class="anchor" id="a402221896b6d7153b14a5ff8dadde806"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selectors for Unicode sets that can be returned by <a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet()</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#aec7c273c8ce917ff75224e25914c53be" title="Returns the set of Unicode code points that can be converted by an ICU converter. ...">ucnv_getUnicodeSet</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001507">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a402221896b6d7153b14a5ff8dadde806ab08c09dd129a92d08725b5260b49cbf9"></a>UCNV_ROUNDTRIP_SET </td><td class="fielddoc">
<p>Select the set of roundtrippable Unicode code points. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001581">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a402221896b6d7153b14a5ff8dadde806a38d95100b8b58d2c66c4c83b30d99499"></a>UCNV_ROUNDTRIP_AND_FALLBACK_SET </td><td class="fielddoc">
<p>Select the set of Unicode code points with roundtrip or fallback mappings. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001582">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a402221896b6d7153b14a5ff8dadde806a33cced69d47e6de3cbfd79d17f88fcaf"></a>UCNV_SET_COUNT </td><td class="fielddoc">
<p>Number of UConverterUnicodeSet selectors. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000082">Deprecated:</a></b></dt><dd>ICU 58 The numeric value may change over time, see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucnv_8h_source.html#l00941">941</a> of file <a class="el" href="ucnv_8h_source.html">ucnv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a1718689bf60724fdfa08c51aa0cc5ea0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the unicode converter and releases resources associated with just this instance. </p>
<p>Does not free up shared converter tables.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the converter object to be deleted </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a82e86d5341b39c543c269c70b8310f3e" title="Creates a Unicode converter with the names specified as unicode string. ">ucnv_openU</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001489">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a6f998746d8a8a8afd837f04dbb1ab64a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucnv_compareNames </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Do a fuzzy compare of two converter/alias names. </p>
<p>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 <a href="http://www.unicode.org/reports/tr22/">http://www.unicode.org/reports/tr22/</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name1</td><td>a converter name or alias, zero-terminated </td></tr>
<tr><td class="paramname">name2</td><td>a converter name or alias, zero-terminated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>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. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001483">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2bdb6b1d3ac4069808348eb6961ce63d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_convert </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>toConverterName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fromConverterName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from one external charset to another. </p>
<p>Internally, two converters are opened according to the name arguments, then the text is converted to and from the 16-bit Unicode "pivot" using <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a>, then the converters are closed again.</p>
<p>This is a convenience function, not an efficient way to convert a lot of text: <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a></p><ul>
<li>takes charset names, not converter objects, so that<ul>
<li>two converters are opened for each call</li>
<li>only single-string conversion is possible, not streaming operation</li>
</ul>
</li>
<li>does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed</li>
<li>allows NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if sourceLength==-1, see parameters)</li>
<li>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</li>
<li>a pivot buffer is provided internally</li>
</ul>
<p>The function returns when one of the following is true:</p><ul>
<li>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</li>
<li>a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR) and the full output string length is returned ("preflighting")</li>
<li>a conversion error occurred (other <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE()</a>, see description of pErrorCode)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toConverterName</td><td>The name of the converter that is used to convert from the UTF-16 pivot buffer to the target. </td></tr>
<tr><td class="paramname">fromConverterName</td><td>The name of the converter that is used to convert from the source to the UTF-16 pivot buffer. </td></tr>
<tr><td class="paramname">target</td><td>Pointer to the output buffer. </td></tr>
<tr><td class="paramname">targetCapacity</td><td>Capacity of the target, in bytes. </td></tr>
<tr><td class="paramname">source</td><td>Pointer to the input buffer. </td></tr>
<tr><td class="paramname">sourceLength</td><td>Length of the input text, in bytes, or -1 for NUL-terminated input. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5" title="Convert from one external charset to another. ">ucnv_fromAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1b619c24f88f8b10f97b64ab1dc4fc86" title="Convert from one external charset to another. ">ucnv_toAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001519">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af4c967c5afa207d064c24e19256586b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_convertEx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>targetCnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>sourceCnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>targetLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sourceLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>pivotStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> ** </td>
<td class="paramname"><em>pivotSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> ** </td>
<td class="paramname"><em>pivotTarget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>pivotLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>reset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from one external charset to another using two existing UConverters. </p>
<p>Internally, two conversions - <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> and <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a> - are used, "pivoting" through 16-bit Unicode.</p>
<p>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.)</p>
<p>There is a similar function, <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a>, which has the following limitations:</p><ul>
<li>it takes charset names, not converter objects, so that<ul>
<li>two converters are opened for each call</li>
<li>only single-string conversion is possible, not streaming operation</li>
</ul>
</li>
<li>it does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed</li>
</ul>
<p>By contrast, <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a></p><ul>
<li>takes UConverter parameters instead of charset names</li>
<li>fully exposes the pivot buffer for streaming conversion and complete error handling</li>
</ul>
<p><a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a> also provides further convenience:</p><ul>
<li>an option to reset the converters at the beginning (if reset==TRUE, see parameters; also sets *pivotTarget=*pivotSource=pivotStart)</li>
<li>allow NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if sourceLimit==NULL, see parameters)</li>
<li>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</li>
<li>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)</li>
</ul>
<p>The function returns when one of the following is true:</p><ul>
<li>the entire source text has been converted successfully to the target buffer</li>
<li>a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR)</li>
<li>a conversion error occurred (other <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE()</a>, see description of pErrorCode)</li>
</ul>
<p>Limitation compared to the direct use of <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a> and <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a>: <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a> does not provide offset information.</p>
<p>Limitation compared to <a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars()</a> and <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a>: <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a> does not support preflighting directly.</p>
<p>Sample code for converting a single string from one external charset to UTF-8, ignoring the location of errors:</p>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> int32_t</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> myToUTF8(UConverter *cnv,</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  const char *s, int32_t length,</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  char *u8, int32_t capacity,</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  UErrorCode *pErrorCode) {</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  UConverter *utf8Cnv;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  char *target;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  if(U_FAILURE(*pErrorCode)) {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  return 0;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  }</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  utf8Cnv=myGetCachedUTF8Converter(pErrorCode);</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  if(U_FAILURE(*pErrorCode)) {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  return 0;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  }</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  if(length<0) {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  length=strlen(s);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  target=u8;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  ucnv_convertEx(utf8Cnv, cnv,</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  &target, u8+capacity,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  &s, s+length,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  NULL, NULL, NULL, NULL,</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  TRUE, TRUE,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  pErrorCode);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  myReleaseCachedUTF8Converter(utf8Cnv);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  // return the output string length, but without preflighting</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  return (int32_t)(target-u8);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">targetCnv</td><td>Output converter, used to convert from the UTF-16 pivot to the target using <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a>. </td></tr>
<tr><td class="paramname">sourceCnv</td><td>Input converter, used to convert from the source to the UTF-16 pivot using <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a>. </td></tr>
<tr><td class="paramname">target</td><td>I/O parameter, same as for <a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars()</a>. Input: *target points to the beginning of the target buffer. Output: *target points to the first unit after the last char written. </td></tr>
<tr><td class="paramname">targetLimit</td><td>Pointer to the first unit after the target buffer. </td></tr>
<tr><td class="paramname">source</td><td>I/O parameter, same as for <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a>. Input: *source points to the beginning of the source buffer. Output: *source points to the first unit after the last char read. </td></tr>
<tr><td class="paramname">sourceLimit</td><td>Pointer to the first unit after the source buffer. </td></tr>
<tr><td class="paramname">pivotStart</td><td>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. </td></tr>
<tr><td class="paramname">pivotSource</td><td>I/O parameter, same as source in <a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars()</a> for conversion from the pivot buffer to the target buffer. </td></tr>
<tr><td class="paramname">pivotTarget</td><td>I/O parameter, same as target in <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a> for conversion from the source buffer to the pivot buffer. It must be pivotStart<=*pivotSource<=*pivotTarget<=pivotLimit and pivotStart<pivotLimit (unless pivotStart==NULL). </td></tr>
<tr><td class="paramname">pivotLimit</td><td>Pointer to the first unit after the pivot buffer. </td></tr>
<tr><td class="paramname">reset</td><td>If TRUE, then ucnv_resetToUnicode(sourceCnv) and ucnv_resetFromUnicode(targetCnv) are called, and the pivot pointers are reset (*pivotTarget=*pivotSource=pivotStart). </td></tr>
<tr><td class="paramname">flush</td><td>If true, indicates the end of the input. Passed directly to <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a>, and carried over to <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a> when the source is empty as well. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>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.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5" title="Convert from one external charset to another. ">ucnv_fromAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1b619c24f88f8b10f97b64ab1dc4fc86" title="Convert from one external charset to another. ">ucnv_toAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001518">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="ab3db46e3d4319ea85ebfde031e2e1bcb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t ucnv_countAliases </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>alias</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the number of aliases for a given converter or alias name. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alias</td><td>alias name </td></tr>
<tr><td class="paramname">pErrorCode</td><td>error status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of names on alias list for given alias </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001526">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a50a330a3628673c9a6a7eb6be30b94ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_countAvailable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of available converters, as per the alias file. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of available converters </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a22feff7d04fe7a9dc62d1f7ecb4eb647" title="Gets the canonical converter name of the specified converter from a list of all available converters ...">ucnv_getAvailableName</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001523">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a78bdc2c475baff8029a6a9782b862384"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t ucnv_countStandards </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the number of standards associated to converter names. </p>
<dl class="section return"><dt>Returns</dt><dd>number of standards </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001530">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad43176e199992be4069b67177ce6d3ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_detectUnicodeSignature </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>signatureLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detects Unicode signature byte sequences at the start of the byte stream and returns the charset name of the indicated Unicode charset. </p>
<p>NULL is returned when no Unicode signature is recognized. The number of bytes in the signature is output as well.</p>
<p>The caller can <a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open()</a> 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.</p>
<p>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. </p>
<p>Usage: </p><div class="fragment"><div class="line"> <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> err = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;</div><div class="line"> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> discardSignature = <a class="code" href="umachine_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>; <span class="comment">/* set to TRUE to throw away the initial U+FEFF */</span></div><div class="line"> <span class="keywordtype">char</span> input[] = { <span class="stringliteral">'\xEF'</span>,<span class="stringliteral">'\xBB'</span>, <span class="stringliteral">'\xBF'</span>,<span class="stringliteral">'\x41'</span>,<span class="stringliteral">'\x42'</span>,<span class="stringliteral">'\x43'</span> };</div><div class="line"> int32_t signatureLength = 0;</div><div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding = <a class="code" href="ucnv_8h.html#ad43176e199992be4069b67177ce6d3ce">ucnv_detectUnicodeSignature</a>(input,<span class="keyword">sizeof</span>(input),&signatureLength,&err);</div><div class="line"> <a class="code" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *conv = <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>;</div><div class="line"> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> output[100];</div><div class="line"> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target = output, *out;</div><div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *source = input;</div><div class="line"> <span class="keywordflow">if</span>(encoding!=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> && <a class="code" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711">U_SUCCESS</a>(err)){</div><div class="line"> <span class="comment">// should signature be discarded ?</span></div><div class="line"> conv = <a class="code" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41">ucnv_open</a>(encoding, &err);</div><div class="line"> <span class="comment">// do the conversion</span></div><div class="line"> <a class="code" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599">ucnv_toUnicode</a>(conv,</div><div class="line"> &target, output + UPRV_LENGTHOF(output),</div><div class="line"> &source, input + <span class="keyword">sizeof</span>(input),</div><div class="line"> <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, <a class="code" href="umachine_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>, &err);</div><div class="line"> out = output;</div><div class="line"> <span class="keywordflow">if</span> (discardSignature){</div><div class="line"> ++out; <span class="comment">// ignore initial U+FEFF</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">while</span>(out != target) {</div><div class="line"> printf(<span class="stringliteral">"%04x "</span>, *out++);</div><div class="line"> }</div><div class="line"> puts(<span class="stringliteral">""</span>);</div><div class="line"> }</div></div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The source string in which the signature should be detected. </td></tr>
<tr><td class="paramname">sourceLength</td><td>Length of the input string, or -1 if terminated with a NUL byte. </td></tr>
<tr><td class="paramname">signatureLength</td><td>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. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the encoding detected. NULL if encoding is not detected. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001540">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a2962e5b30828db79345b5250cf411f90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_fixFileSeparator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fixes the backslash character mismapping. </p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter representing the target codepage. </td></tr>
<tr><td class="paramname">source</td><td>the input buffer to be fixed </td></tr>
<tr><td class="paramname">sourceLen</td><td>the length of the input buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#ac38aa0a9daa58ca49dda17b2b7d40b8c" title="Determines if the converter contains ambiguous mappings of the same character or not. ">ucnv_isAmbiguous</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001536">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab0c427930c575dac20c0166ad4ef0986"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_flushCache </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees up memory occupied by unused, cached converter shared data. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of cached converters successfully deleted </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001522">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5cd24dc4d6c2fbec8c6481309459b7d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_fromAlgorithmic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> </td>
<td class="paramname"><em>algorithmicType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from one external charset to another. </p>
<p>Internally, the text is converted to and from the 16-bit Unicode "pivot" using <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a>. <a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5" title="Convert from one external charset to another. ">ucnv_fromAlgorithmic()</a> works exactly like <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a> except that the two converters need not be looked up and opened completely.</p>
<p>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.</p>
<p>Internally, the algorithmic converter is opened and closed for each function call, which is more efficient than using the public <a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open()</a> but somewhat less efficient than only resetting an existing converter and using <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a>.</p>
<p>This function is more convenient than <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a> 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 <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a> for details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter that is used to convert from the UTF-16 pivot buffer to the target. </td></tr>
<tr><td class="paramname">algorithmicType</td><td>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. </td></tr>
<tr><td class="paramname">target</td><td>Pointer to the output buffer. </td></tr>
<tr><td class="paramname">targetCapacity</td><td>Capacity of the target, in bytes. </td></tr>
<tr><td class="paramname">source</td><td>Pointer to the input buffer. </td></tr>
<tr><td class="paramname">sourceLength</td><td>Length of the input text, in bytes </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5" title="Convert from one external charset to another. ">ucnv_fromAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001521">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a31bd5a5af440108a1a51bb0234ad32ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_fromUChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert the Unicode string into a codepage string using an existing UConverter. </p>
<p>The output string is NUL-terminated if possible.</p>
<p>This function is a more convenient but less powerful version of <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a>. It is only useful for whole strings, not for streaming conversion.</p>
<p>The maximum output buffer capacity required (barring output from callbacks) will be <a class="el" href="ucnv_8h.html#aa3d7e4ae84f8a95b9735ed3491cdb77e" title="Calculates the size of a buffer for conversion from Unicode to a charset. ">UCNV_GET_MAX_BYTES_FOR_STRING(srcLength, ucnv_getMaxCharSize(cnv))</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>the converter object to be used (<a class="el" href="ucnv_8h.html#aba8147239dca1fe5773de4905f2f74c2" title="Resets the from-Unicode part of a converter state to the default state. ">ucnv_resetFromUnicode()</a> will be called) </td></tr>
<tr><td class="paramname">src</td><td>the input Unicode string </td></tr>
<tr><td class="paramname">srcLength</td><td>the input string length, or -1 if NUL-terminated </td></tr>
<tr><td class="paramname">dest</td><td>destination string buffer, can be NULL if destCapacity==0 </td></tr>
<tr><td class="paramname">destCapacity</td><td>the number of chars available at dest </td></tr>
<tr><td class="paramname">pErrorCode</td><td>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 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>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 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aa3d7e4ae84f8a95b9735ed3491cdb77e" title="Calculates the size of a buffer for conversion from Unicode to a charset. ">UCNV_GET_MAX_BYTES_FOR_STRING</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001515">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1d848a6a75fc14c38485ecd908694ac0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_fromUCountPending </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of UChars held in the converter's internal state because more input is needed for completing the conversion. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter in which the input is held </td></tr>
<tr><td class="paramname">status</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of UChars in the state. -1 if an error is encountered. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001541">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a4a1f09772549fbcd7dd782297212c19f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_fromUnicode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>targetLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> ** </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>sourceLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>offsets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts an array of unicode characters to an array of codepage characters. </p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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.)</p>
<p>This is a <em>stateful</em> 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 <code>U_BUFFER_OVERFLOW_ERROR</code>, 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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">target</td><td>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 <code>target</code>. </td></tr>
<tr><td class="paramname">targetLimit</td><td>the pointer just after last of the <code>target</code> buffer </td></tr>
<tr><td class="paramname">source</td><td>I/O parameter, pointer to pointer to the source Unicode character buffer. </td></tr>
<tr><td class="paramname">sourceLimit</td><td>the pointer just after the last of the source buffer </td></tr>
<tr><td class="paramname">offsets</td><td>if NULL is passed, nothing will happen to it, otherwise it needs to have the same number of allocated cells as <code>target</code>. Will fill in offsets from target to source pointer e.g: <code>offsets[3]</code> is equal to 6, it means that the <code>target[3]</code> was a result of transcoding <code>source[6]</code> 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. </td></tr>
<tr><td class="paramname">flush</td><td>set to <code>TRUE</code> if the current source buffer is the last available chunk of the source, <code>FALSE</code> otherwise. Note that if a failing status is returned, this function may have to be called multiple times with flush set to <code>TRUE</code> until the source buffer is consumed. </td></tr>
<tr><td class="paramname">err</td><td>the error status. <code>U_ILLEGAL_ARGUMENT_ERROR</code> will be set if the converter is <code>NULL</code>. <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is still data to be written to the target. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a12edd465a611c41e418632f5d5f2dbe4" title="Returns the minimum byte length (per codepoint) for characters in this codepage. ">ucnv_getMinCharSize</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#ab1f96fe9de8e2ee39159f748a8d33a4b" title="Changes the callback function used by the converter when an illegal or invalid sequence is found...">ucnv_setToUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001513">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a686d4e3d2905f3e2819577391fd08c2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getAlias </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>alias</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the name of the alias at given index of alias list. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alias</td><td>alias name </td></tr>
<tr><td class="paramname">n</td><td>index in alias list </td></tr>
<tr><td class="paramname">pErrorCode</td><td>result of operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns the name of the alias at given index </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#ab3db46e3d4319ea85ebfde031e2e1bcb" title="Gives the number of aliases for a given converter or alias name. ">ucnv_countAliases</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001527">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae16a53f19829be2f5227d0259e3120eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getAliases </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>alias</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>aliases</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fill-up the list of alias names for the given alias. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alias</td><td>alias name </td></tr>
<tr><td class="paramname">aliases</td><td>fill-in list, aliases is a pointer to an array of <code><a class="el" href="ucnv_8h.html#ab3db46e3d4319ea85ebfde031e2e1bcb" title="Gives the number of aliases for a given converter or alias name. ">ucnv_countAliases()</a></code> string-pointers (<code>const char *</code>) that will be filled in. The strings themselves are owned by the library. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>result of operation </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001528">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a22feff7d04fe7a9dc62d1f7ecb4eb647"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getAvailableName </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the canonical converter name of the specified converter from a list of all available converters contaied in the alias file. </p>
<p>All converters in this list can be opened.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>the index to a converter available on the system (in the range <code>[0..ucnv_countAvaiable()]</code>) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer a string (library owned), or <code>NULL</code> if the index is out of bounds. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a50a330a3628673c9a6a7eb6be30b94ae" title="Returns the number of available converters, as per the alias file. ">ucnv_countAvailable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001524">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1601f0d125e4b695ad1f84d6db441e6e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getCanonicalName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>alias</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>standard</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will return the internal canonical converter name of the tagged alias. </p>
<p>This is the opposite of ucnv_openStandardNames, which returns the tagged alias given the canonical name. </p>
<p>Example alias table:<br />
conv alias1 { STANDARD1 } alias2 { STANDARD1* } </p>
<p>Result of ucnv_getStandardName("alias1", "STANDARD1") from example alias table:<br />
<b>"conv"</b></p>
<dl class="section return"><dt>Returns</dt><dd>returns the canonical converter name; if a standard or alias name cannot be determined, then <code>NULL</code> is returned. The returned string is owned by the library. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a2e1030c73ab423ec40b7b947320936c2" title="Returns a standard name for a given converter name. ">ucnv_getStandardName</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001533">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a0500738a0f4a552725725f9fe964e430"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_getCCSID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a codepage number associated with the converter. </p>
<p>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 <code>NULL</code> or if converter's data table is <code>NULL</code>.</p>
<p>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 <a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">err</td><td>the error status code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If any error occurrs, -1 will be returned otherwise, the codepage number will be returned </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aa14f20f0ffa7f602690956cf3a5c87e2" title="Gets a codepage platform associated with the converter. ">ucnv_getPlatform</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001503">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a611d8da795489692511b07525a2f8b95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getDefaultName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current default converter name. </p>
<p>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.</p>
<p>If U_CHARSET_IS_UTF8 is defined to 1 in <a class="el" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs. ">utypes.h</a> then this function always returns "UTF-8".</p>
<dl class="section return"><dt>Returns</dt><dd>returns the current default converter name. Storage owned by the library </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a1a2aaa1bd664b8b53da8cb50f1025bf9" title="This function is not thread safe. ">ucnv_setDefaultName</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001534">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a36c33bb6459c126f64e5472c6e5023a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>displayName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>displayNameCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the display name of the converter passed in based on the Locale passed in. </p>
<p>If the locale contains no display name, the internal ASCII name will be filled in.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter. </td></tr>
<tr><td class="paramname">displayLocale</td><td>is the specific Locale we want to localised for </td></tr>
<tr><td class="paramname">displayName</td><td>user provided buffer to be filled in </td></tr>
<tr><td class="paramname">displayNameCapacity</td><td>size of displayName Buffer </td></tr>
<tr><td class="paramname">err</td><td>error status code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>displayNameLength number of UChar needed in displayName </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#aac2e332117c919a01516c726c051dd55" title="Gets the internal, canonical name of the converter (zero-terminated). ">ucnv_getName</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001501">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2a2dcbf10e3b08a97ed0b06466d9e8a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getFromUCallBack </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> * </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current callback function used by the converter when illegal or invalid Unicode sequence is found. </p>
<p>Context pointers are always owned by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the unicode converter </td></tr>
<tr><td class="paramname">action</td><td>fillin: returns the callback function pointer </td></tr>
<tr><td class="paramname">context</td><td>fillin: returns the callback's private void* context </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a59fdaf2cf5dc57d738ed7a7657f6b03a" title="Changes the current callback function used by the converter when an illegal or invalid sequence is fo...">ucnv_setFromUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001510">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae8c925ce8f47ab08c53f9e3b3b9664f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getInvalidChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>errBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t * </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills in the output parameter, errBytes, with the error characters from the last failing conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">errBytes</td><td>the codepage bytes which were in error </td></tr>
<tr><td class="paramname">len</td><td>on input the capacity of errBytes, on output the number of bytes which were copied to it </td></tr>
<tr><td class="paramname">err</td><td>the error status code. If the substitution character array is too small, an <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001493">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a341f4716c12e62d24cc8431eb9dfecdd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getInvalidUChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>errUChars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t * </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills in the output parameter, errChars, with the error characters from the last failing conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">errUChars</td><td>the UChars which were in error </td></tr>
<tr><td class="paramname">len</td><td>on input the capacity of errUChars, on output the number of UChars which were copied to it </td></tr>
<tr><td class="paramname">err</td><td>the error status code. If the substitution character array is too small, an <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001494">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a11007a7bcc41b1030cda0ee28fe78195"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t ucnv_getMaxCharSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this converter. </p>
<p>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.</p>
<p>Note: Before ICU 2.8, this function did not return reliable numbers for some stateful converters (EBCDIC_STATEFUL, ISO-2022) and LMBCS.</p>
<p>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.</p>
<p>Examples for special cases that are taken into account:</p><ul>
<li>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.</li>
<li>State-shifting output (SI/SO, escapes, etc.) from stateful converters.</li>
<li>When m input UChars are converted to n output bytes, then the maximum m/n is taken into account.</li>
</ul>
<p>The number returned here does not take into account (see UCNV_GET_MAX_BYTES_FOR_STRING):</p><ul>
<li>callbacks which output more than one charset character sequence per call, like escape callbacks</li>
<li>initial and final non-character bytes that are output by some converters (automatic BOMs, initial escape sequence, final SI, etc.)</li>
</ul>
<p>Examples for returned values:</p><ul>
<li>SBCS charsets: 1</li>
<li>Shift-JIS: 2</li>
<li>UTF-16: 2 (2 per BMP, 4 per surrogate <em>pair</em>, BOM not counted)</li>
<li>UTF-8: 3 (3 per BMP, 4 per surrogate <em>pair</em>)</li>
<li>EBCDIC_STATEFUL (EBCDIC mixed SBCS/DBCS): 3 (SO + DBCS)</li>
<li>ISO-2022: 3 (always outputs UTF-8)</li>
<li>ISO-2022-JP: 6 (4-byte escape sequences + DBCS)</li>
<li>ISO-2022-CN: 8 (4-byte designator sequences + 2-byte SS2/SS3 + DBCS)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>The Unicode converter. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The maximum number of bytes per UChar (16 bit code unit) that are output by <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a>, to be used together with UCNV_GET_MAX_BYTES_FOR_STRING for buffer allocation.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#aa3d7e4ae84f8a95b9735ed3491cdb77e" title="Calculates the size of a buffer for conversion from Unicode to a charset. ">UCNV_GET_MAX_BYTES_FOR_STRING</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a12edd465a611c41e418632f5d5f2dbe4" title="Returns the minimum byte length (per codepoint) for characters in this codepage. ">ucnv_getMinCharSize</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001498">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a12edd465a611c41e418632f5d5f2dbe4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t ucnv_getMinCharSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the minimum byte length (per codepoint) for characters in this codepage. </p>
<p>This is usually either 1 or 2. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of bytes per codepoint allowed by this particular converter </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a11007a7bcc41b1030cda0ee28fe78195" title="Returns the maximum number of bytes that are output per UChar in conversion from Unicode using this c...">ucnv_getMaxCharSize</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001500">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aac2e332117c919a01516c726c051dd55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the internal, canonical name of the converter (zero-terminated). </p>
<p>The lifetime of the returned string will be that of the converter passed to this function. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">err</td><td>UErrorCode status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the internal name of the converter </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a36c33bb6459c126f64e5472c6e5023a6" title="Returns the display name of the converter passed in based on the Locale passed in. ">ucnv_getDisplayName</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001502">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aaf391b89870fd88b3da838eff1bd6ba6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> ucnv_getNextUChar </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sourceLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a codepage buffer into Unicode one character at a time. </p>
<p>The input is completely consumed when the U_INDEX_OUTOFBOUNDS_ERROR is set.</p>
<p>Advantage compared to <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> or <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a>:</p><ul>
<li>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 <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> internally.)</li>
<li>Convenient.</li>
</ul>
<p>Limitations compared to <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a>:</p><ul>
<li>Always assumes flush=TRUE. This makes <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> unsuitable for "streaming" conversion, that is, for where the input is supplied in multiple buffers, because <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> will assume the end of the input at the end of the first buffer.</li>
<li>Does not provide offset output.</li>
</ul>
<p>It is possible to "mix" <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> and <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> because <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> uses the current state of the converter (unlike <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a> which always resets first). However, if <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> is called after <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> stopped in the middle of a character sequence (with flush=FALSE), then <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> will always use the slower <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> internally until the next character boundary. (This is new in ICU 2.6. In earlier releases, <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a> had to start at a character boundary.)</p>
<p>Instead of using <a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar()</a>, it is recommended to convert using <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a> or <a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars()</a> and then iterate over the text using <a class="el" href="utf16_8h.html#a844bb48486904fdca40c8b883e9c80ee" title="Get a code point from a string at a code point boundary offset, and advance the offset to the next co...">U16_NEXT()</a> or a <a class="el" href="structUCharIterator.html" title="C API for code unit iteration. ">UCharIterator</a> (<a class="el" href="uiter_8h.html" title="C API: Unicode Character Iteration. ">uiter.h</a>) or a C++ CharacterIterator or similar. This allows streaming conversion and offset output, for example.</p>
<p>Handling of surrogate pairs and supplementary-plane code points:<br />
There are two different kinds of codepages that provide mappings for surrogate characters: </p><ul>
<li>
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. </li>
<li>
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.) </li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>an open UConverter </td></tr>
<tr><td class="paramname">source</td><td>the address of a pointer to the codepage buffer, will be updated to point after the bytes consumed in the conversion call. </td></tr>
<tr><td class="paramname">sourceLimit</td><td>points to the end of the input buffer </td></tr>
<tr><td class="paramname">err</td><td>fills in error status (see ucnv_toUnicode) <code>U_INDEX_OUTOFBOUNDS_ERROR</code> 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 <code>U_BUFFER_OVERFLOW_ERROR</code> 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. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a UChar32 resulting from the partial conversion of source </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001517">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa14f20f0ffa7f602690956cf3a5c87e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a> ucnv_getPlatform </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a codepage platform associated with the converter. </p>
<p>Currently, only <code>UCNV_IBM</code> will be returned. Does not test if the converter is <code>NULL</code> or if converter's data table is <code>NULL</code>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">err</td><td>the error status code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The codepage platform </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001504">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a96c90729859689a2ae7c29f3f7f1306a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getStandard </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the name of the standard at given index of standard list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>index in standard list </td></tr>
<tr><td class="paramname">pErrorCode</td><td>result of operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns the name of the standard at given index. Owned by the library. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001531">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2e1030c73ab423ec40b7b947320936c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucnv_getStandardName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>standard</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a standard name for a given converter name. </p>
<p>Example alias table:<br />
conv alias1 { STANDARD1 } alias2 { STANDARD1* } </p>
<p>Result of ucnv_getStandardName("conv", "STANDARD1") from example alias table:<br />
<b>"alias2"</b></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>original converter name </td></tr>
<tr><td class="paramname">standard</td><td>name of the standard governing the names; MIME and IANA are such standards </td></tr>
<tr><td class="paramname">pErrorCode</td><td>result of operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns the standard converter name; if a standard converter name cannot be determined, then <code>NULL</code> is returned. Owned by the library. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001532">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa970dda00a55c1751b7fe0bb34b04015"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getStarters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>starters</em>[256], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the "starter" (lead) bytes for converters of type MBCS. </p>
<p>Will fill in an <code>U_ILLEGAL_ARGUMENT_ERROR</code> 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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>a valid, opened converter of type MBCS </td></tr>
<tr><td class="paramname">starters</td><td>an array of size 256 to be filled in </td></tr>
<tr><td class="paramname">err</td><td>error status, <code>U_ILLEGAL_ARGUMENT_ERROR</code> if the converter is not a type which can return starters. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a94a8af5dd3516cea50c2829e6c35b397" title="Gets the type of the converter e.g. ">ucnv_getType</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001506">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a118a87477ffa827d00dd50727da02e31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getSubstChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>subChars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t * </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills in the output parameter, subChars, with the substitution characters as multiple bytes. </p>
<p>If <a class="el" href="ucnv_8h.html#af87333c550d699794ab84151ed9007c6" title="Set a substitution string for converting from Unicode to a charset. ">ucnv_setSubstString()</a> set a Unicode string because the converter is stateful, then subChars will be an empty string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">subChars</td><td>the subsitution characters </td></tr>
<tr><td class="paramname">len</td><td>on input the capacity of subChars, on output the number of bytes copied to it </td></tr>
<tr><td class="paramname">err</td><td>the outgoing error status code. If the substitution character array is too small, an <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#af87333c550d699794ab84151ed9007c6" title="Set a substitution string for converting from Unicode to a charset. ">ucnv_setSubstString</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#ac160b1b44ac9b5124ec083810709603a" title="Sets the substitution chars when converting from unicode to a codepage. ">ucnv_setSubstChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001490">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af45faec39053767f4a7a779586c24223"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getToUCallBack </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> * </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current calback function used by the converter when an illegal or invalid codepage sequence is found. </p>
<p>Context pointers are always owned by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the unicode converter </td></tr>
<tr><td class="paramname">action</td><td>fillin: returns the callback function pointer </td></tr>
<tr><td class="paramname">context</td><td>fillin: returns the callback's private void* context </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#ab1f96fe9de8e2ee39159f748a8d33a4b" title="Changes the callback function used by the converter when an illegal or invalid sequence is found...">ucnv_setToUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001509">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a94a8af5dd3516cea50c2829e6c35b397"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> ucnv_getType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the type of the converter e.g. </p>
<p>SBCS, MBCS, DBCS, UTF8, UTF16_BE, UTF16_LE, ISO_2022, EBCDIC_STATEFUL, LATIN_1 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>a valid, opened converter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the type of the converter </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001505">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aec7c273c8ce917ff75224e25914c53be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_getUnicodeSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>setFillIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> </td>
<td class="paramname"><em>whichSet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the set of Unicode code points that can be converted by an ICU converter. </p>
<p>Returns one of several kinds of set:</p>
<ol type="1">
<li>UCNV_ROUNDTRIP_SET</li>
</ol>
<p>The set of all Unicode code points that can be roundtrip-converted (converted without any data loss) with the converter (<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a>). 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 <a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a> will always uses those mappings despite <a class="el" href="ucnv_8h.html#a117c45b5c1d746c6f532f44985b686e4" title="Sets the converter to use fallback mappings or not. ">ucnv_setFallback()</a>. See UTR #22 "Character Mapping Markup Language" at <a href="http://www.unicode.org/reports/tr22/">http://www.unicode.org/reports/tr22/</a></p>
<p>This is useful for example for</p><ul>
<li>checking that a string or document can be roundtrip-converted with a converter, without/before actually performing the conversion</li>
<li>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</li>
</ul>
<ol type="1">
<li>UCNV_ROUNDTRIP_AND_FALLBACK_SET</li>
</ol>
<p>The set of all Unicode code points that can be converted with the converter (<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode()</a>) when fallbacks are turned on (see <a class="el" href="ucnv_8h.html#a117c45b5c1d746c6f532f44985b686e4" title="Sets the converter to use fallback mappings or not. ">ucnv_setFallback()</a>). This set includes all code points with roundtrips and fallbacks (but not reverse fallbacks).</p>
<p>In the future, there may be more UConverterUnicodeSet choices to select sets with different properties.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter for which a set is requested. </td></tr>
<tr><td class="paramname">setFillIn</td><td>A valid USet *. It will be cleared by this function before the converter's specific set is filled into the USet. </td></tr>
<tr><td class="paramname">whichSet</td><td>A UConverterUnicodeSet selector; currently UCNV_ROUNDTRIP_SET is the only supported value. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806" title="Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet(). ">UConverterUnicodeSet</a> </dd>
<dd>
<a class="el" href="uset_8h.html#a65a4e226273821916545e45dee27a144" title="Creates a USet object that contains the range of characters start..end, inclusive. ">uset_open</a> </dd>
<dd>
<a class="el" href="uset_8h.html#abb0d0fb8d660204fd7fef7fe920bb70c" title="Disposes of the storage used by a USet object. ">uset_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001508">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="ac38aa0a9daa58ca49dda17b2b7d40b8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucnv_isAmbiguous </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the converter contains ambiguous mappings of the same character or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>the converter to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the converter contains ambiguous mapping of the same character, FALSE otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001537">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7dde59e660b06fe6a47cc55b38e0a68e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucnv_isFixedWidth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether or not the charset of the converter has a fixed number of bytes per charset character. </p>
<p>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 <em>units</em> for any particular Unicode encoding form. FALSE is returned with the UErrorCode if error occurs or cnv is NULL. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter to be tested </td></tr>
<tr><td class="paramname">status</td><td>ICU error code in/out paramter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the converter is fixed-width </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001543">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a485c78d4149165f504effa2287717e41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a>* ucnv_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>converterName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a UConverter object with the name of a coded character set specified as a C string. </p>
<p>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 <a class="el" href="ucnv_8h.html#a6f998746d8a8a8afd837f04dbb1ab64a" title="Do a fuzzy compare of two converter/alias names. ">ucnv_compareNames()</a>.) If <code>NULL</code> is passed for the converter name, it will create one with the getDefaultName return value.</p>
<p>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.</p>
<p>Options are appended to the converter name string, with a <code>UCNV_OPTION_SEP_CHAR</code> between the name and the first option and also between adjacent options.</p>
<p>If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.</p>
<p>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 <a href="http://icu-project.org/userguide/conversion.html">User's Guide</a>. 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.</p>
<div class="fragment"><div class="line"> conv = <a class="code" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41">ucnv_open</a>(<span class="stringliteral">"koi8-r"</span>, &status);</div></div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converterName</td><td>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. </td></tr>
<tr><td class="paramname">err</td><td>outgoing error status <code>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created Unicode converter object, or <code>NULL</code> if an error occured </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a82e86d5341b39c543c269c70b8310f3e" title="Creates a Unicode converter with the names specified as unicode string. ">ucnv_openU</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a22feff7d04fe7a9dc62d1f7ecb4eb647" title="Gets the canonical converter name of the specified converter from a list of all available converters ...">ucnv_getAvailableName</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a686d4e3d2905f3e2819577391fd08c2c" title="Gives the name of the alias at given index of alias list. ">ucnv_getAlias</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a611d8da795489692511b07525a2f8b95" title="Returns the current default converter name. ">ucnv_getDefaultName</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a6f998746d8a8a8afd837f04dbb1ab64a" title="Do a fuzzy compare of two converter/alias names. ">ucnv_compareNames</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001484">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a23282ab66962108aa8eba7096e4499ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucnv_openAllNames </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a UEnumeration to enumerate all of the canonical converter names, as per the alias file, regardless of the ability to open each converter. </p>
<dl class="section return"><dt>Returns</dt><dd>A UEnumeration object for getting all the recognized canonical converter names. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a22feff7d04fe7a9dc62d1f7ecb4eb647" title="Gets the canonical converter name of the specified converter from a list of all available converters ...">ucnv_getAvailableName</a> </dd>
<dd>
<a class="el" href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df" title="Disposes of resources in use by the iterator. ">uenum_close</a> </dd>
<dd>
<a class="el" href="uenum_8h.html#a99298eabaa3874cdfd9793b207848f68" title="Returns the next element in the iterator's list. ">uenum_next</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001525">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a9df0109e866c32078ab96fd2fe994b15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a>* ucnv_openCCSID </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>codepage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85">UConverterPlatform</a> </td>
<td class="paramname"><em>platform</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a UConverter object from a CCSID number and platform pair. </p>
<p>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.</p>
<p>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.</p>
<p>Only IBM default conversion tables are accessible with <a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID()</a>. <a class="el" href="ucnv_8h.html#a0500738a0f4a552725725f9fe964e430" title="Gets a codepage number associated with the converter. ">ucnv_getCCSID()</a> will return the same CCSID for all conversion tables that are associated with that CCSID.</p>
<p>Currently, the only "platform" supported in the ICU converter API is UCNV_IBM.</p>
<p>In summary, the use of CCSIDs and the associated API functions is not recommended.</p>
<p>In order to open a converter with the default IBM CDRA Unicode conversion table, you can use this function or use the prefix "ibm-": </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> char name[20];</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> sprintf(name, "ibm-%hu", ccsid);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> cnv=ucnv_open(name, &errorCode);</div></div><!-- fragment --><p>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: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> char name[20];</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> sprintf(name, "ibm-%hu" UCNV_SWAP_LFNL_OPTION_STRING, ccsid);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> cnv=ucnv_open(name, &errorCode);</div></div><!-- fragment --><p>In order to open a converter from a Microsoft codepage number, use the prefix "cp": </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> char name[20];</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> sprintf(name, "cp%hu", codepageID);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> cnv=ucnv_open(name, &errorCode);</div></div><!-- fragment --><p>If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">codepage</td><td>codepage number to create </td></tr>
<tr><td class="paramname">platform</td><td>the platform in which the codepage number exists </td></tr>
<tr><td class="paramname">err</td><td>error status <code>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created Unicode converter object, or <code>NULL</code> if an error occured. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a82e86d5341b39c543c269c70b8310f3e" title="Creates a Unicode converter with the names specified as unicode string. ">ucnv_openU</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a0500738a0f4a552725725f9fe964e430" title="Gets a codepage number associated with the converter. ">ucnv_getCCSID</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aa14f20f0ffa7f602690956cf3a5c87e2" title="Gets a codepage platform associated with the converter. ">ucnv_getPlatform</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aba5ba7fbc2f113618ba57f4d9825ff85" title="Enum for specifying which platform a converter ID refers to. ">UConverterPlatform</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001486">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7e3fc1e59ac1404120f242b8911cadbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a>* ucnv_openPackage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>converterName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a UConverter object specified from a packageName and a converterName.</p>
<p>The packageName and converterName must point to an ICU udata object, as defined by <code> udata_open( packageName, "cnv", converterName, err) </code> or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with <a class="el" href="udata_8h.html#a406559067e309c05fb90b2d532f11835" title="This function bypasses the normal ICU data loading process for application-specific data and allows y...">udata_setAppData()</a>. Using a full file or directory pathname for packageName is deprecated.</p>
<p>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 <a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e" title="Thread safe converter cloning operation. ">ucnv_safeClone()</a> function to clone a 'master' converter.</p>
<p>A future version of ICU may add alias table lookups and/or caching to this function.</p>
<p>Example Use: <code>cnv = ucnv_openPackage("myapp", "myconverter", &err);</code> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">packageName</td><td>name of the package (equivalent to 'path' in <a class="el" href="udata_8h.html#a3d908d77900b182403a375793ad35a86" title="Convenience function. ">udata_open()</a> call) </td></tr>
<tr><td class="paramname">converterName</td><td>name of the data item to be used, without suffix. </td></tr>
<tr><td class="paramname">err</td><td>outgoing error status <code>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created Unicode converter object, or <code>NULL</code> if an error occured </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="udata_8h.html#a3d908d77900b182403a375793ad35a86" title="Convenience function. ">udata_open</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a11a66c267dce12a78dac2690d983d69e" title="Thread safe converter cloning operation. ">ucnv_safeClone</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001487">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ab6901c3ca8e871ef1efaa14d7f653d40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucnv_openStandardNames </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>convName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>standard</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a new UEnumeration object for enumerating all the alias names for a given converter that are recognized by a standard. </p>
<p>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 <code>ucnv_getStandardName</code>, which is the default alias for the specified standard name. The returned object must be closed with <code>uenum_close</code> when you are done with the object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">convName</td><td>original converter name </td></tr>
<tr><td class="paramname">standard</td><td>name of the standard governing the names; MIME and IANA are such standards </td></tr>
<tr><td class="paramname">pErrorCode</td><td>The error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A UEnumeration object for getting all aliases that are recognized by a standard. If any of the parameters are invalid, NULL is returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a2e1030c73ab423ec40b7b947320936c2" title="Returns a standard name for a given converter name. ">ucnv_getStandardName</a> </dd>
<dd>
<a class="el" href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df" title="Disposes of resources in use by the iterator. ">uenum_close</a> </dd>
<dd>
<a class="el" href="uenum_8h.html#a99298eabaa3874cdfd9793b207848f68" title="Returns the next element in the iterator's list. ">uenum_next</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001529">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a82e86d5341b39c543c269c70b8310f3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a>* ucnv_openU </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a Unicode converter with the names specified as unicode string. </p>
<p>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 <a class="el" href="ucnv_8h.html#a6f998746d8a8a8afd837f04dbb1ab64a" title="Do a fuzzy compare of two converter/alias names. ">ucnv_compareNames()</a>.) If <code>NULL</code> is passed for the converter name, it will create one with the <a class="el" href="ucnv_8h.html#a611d8da795489692511b07525a2f8b95" title="Returns the current default converter name. ">ucnv_getDefaultName()</a> return value. If the alias is ambiguous, then the preferred converter is used and the status is set to U_AMBIGUOUS_ALIAS_WARNING.</p>
<p>See ucnv_open for the complete details</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the UConverter table in a zero terminated Unicode string </td></tr>
<tr><td class="paramname">err</td><td>outgoing error status <code>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created Unicode converter object, or <code>NULL</code> if an error occured </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a9df0109e866c32078ab96fd2fe994b15" title="Creates a UConverter object from a CCSID number and platform pair. ">ucnv_openCCSID</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a6f998746d8a8a8afd837f04dbb1ab64a" title="Do a fuzzy compare of two converter/alias names. ">ucnv_compareNames</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001485">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ace43ec88f1615422f3c5c972ae79deba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the state of a converter to the default state. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001495">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aba8147239dca1fe5773de4905f2f74c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_resetFromUnicode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the from-Unicode part of a converter state to the default state. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001497">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a8711b61a6cd41d84cf522042b3aebaed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_resetToUnicode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the to-Unicode part of a converter state to the default state. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001496">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a11a66c267dce12a78dac2690d983d69e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a>* ucnv_safeClone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>stackBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pBufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Thread safe converter cloning operation. </p>
<p>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.)</p>
<p>You must <a class="el" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance. ">ucnv_close()</a> the clone in any case.</p>
<p>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").</p>
<p>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.</p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>converter to be cloned </td></tr>
<tr><td class="paramname">stackBuffer</td><td><em>Deprecated functionality as of ICU 52, use NULL.</em><br />
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. </td></tr>
<tr><td class="paramname">pBufferSize</td><td><em>Deprecated functionality as of ICU 52, use NULL or 1.</em><br />
pointer to size of allocated space. </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors An informational status value, U_SAFECLONE_ALLOCATED_WARNING, is used if 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. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the new clone </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001488">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1a2aaa1bd664b8b53da8cb50f1025bf9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setDefaultName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is not thread safe. </p>
<p>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 <a class="el" href="ucnv_8h.html#a611d8da795489692511b07525a2f8b95" title="Returns the current default converter name. ">ucnv_getDefaultName()</a> or ucnv_open with a NULL string argument is sufficient for your application.</p>
<p>If U_CHARSET_IS_UTF8 is defined to 1 in <a class="el" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs. ">utypes.h</a> then this function does nothing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the converter name to be the default (must be known by ICU). </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a611d8da795489692511b07525a2f8b95" title="Returns the current default converter name. ">ucnv_getDefaultName</a> </dd></dl>
<dl class="system"><dt><b><a class="el" href="system.html#_system000014">System:</a></b></dt><dd>Do not use unless you know what you are doing. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001535">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a117c45b5c1d746c6f532f44985b686e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setFallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>usesFallback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the converter to use fallback mappings or not. </p>
<p>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: <a href="http://www.icu-project.org/userguide/conversion-data.html#ucmformat">http://www.icu-project.org/userguide/conversion-data.html#ucmformat</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter to set the fallback mapping usage on. </td></tr>
<tr><td class="paramname">usesFallback</td><td>TRUE if the user wants the converter to take advantage of the fallback mapping, FALSE otherwise. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001538">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a036433918c08965c4c687892036db3eb" title="Determines if the converter uses fallback mappings or not. ">ucnv_usesFallback</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a59fdaf2cf5dc57d738ed7a7657f6b03a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setFromUCallBack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> </td>
<td class="paramname"><em>newAction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>newContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#ad9f3c1c236ab58bbc133783968f49750">UConverterFromUCallback</a> * </td>
<td class="paramname"><em>oldAction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"><em>oldContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the current callback function used by the converter when an illegal or invalid sequence is found. </p>
<p>Context pointers are always owned by the caller. Predefined actions and contexts can be found in the <a class="el" href="ucnv__err_8h.html" title="C UConverter predefined error callbacks. ">ucnv_err.h</a> header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the unicode converter </td></tr>
<tr><td class="paramname">newAction</td><td>the new callback function </td></tr>
<tr><td class="paramname">newContext</td><td>the new fromUnicode callback context pointer. This can be NULL. </td></tr>
<tr><td class="paramname">oldAction</td><td>fillin: returns the old callback function pointer. This can be NULL. </td></tr>
<tr><td class="paramname">oldContext</td><td>fillin: returns the old callback's private void* context. This can be NULL. </td></tr>
<tr><td class="paramname">err</td><td>The error code status </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a2a2dcbf10e3b08a97ed0b06466d9e8a5" title="Gets the current callback function used by the converter when illegal or invalid Unicode sequence is ...">ucnv_getFromUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001512">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac160b1b44ac9b5124ec083810709603a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setSubstChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>subChars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the substitution chars when converting from unicode to a codepage. </p>
<p>The substitution is specified as a string of 1-4 bytes, and may contain <code>NULL</code> 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 <a class="el" href="ucnv_8h.html#af87333c550d699794ab84151ed9007c6" title="Set a substitution string for converting from Unicode to a charset. ">ucnv_setSubstString()</a> function relaxes these limitations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">subChars</td><td>the substitution character byte sequence we want set </td></tr>
<tr><td class="paramname">len</td><td>the number of bytes in subChars </td></tr>
<tr><td class="paramname">err</td><td>the error status code. <code>U_INDEX_OUTOFBOUNDS_ERROR </code> if len is bigger than the maximum number of bytes allowed in subchars </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#af87333c550d699794ab84151ed9007c6" title="Set a substitution string for converting from Unicode to a charset. ">ucnv_setSubstString</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a118a87477ffa827d00dd50727da02e31" title="Fills in the output parameter, subChars, with the substitution characters as multiple bytes...">ucnv_getSubstChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001491">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af87333c550d699794ab84151ed9007c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setSubstString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a substitution string for converting from Unicode to a charset. </p>
<p>The caller need not know the charset byte sequence for each charset.</p>
<p>Unlike <a class="el" href="ucnv_8h.html#ac160b1b44ac9b5124ec083810709603a" title="Sets the substitution chars when converting from unicode to a codepage. ">ucnv_setSubstChars()</a> 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.</p>
<p>Also unlike <a class="el" href="ucnv_8h.html#ac160b1b44ac9b5124ec083810709603a" title="Sets the substitution chars when converting from unicode to a codepage. ">ucnv_setSubstChars()</a>, this function works for stateful charsets by converting on the fly at the point of substitution rather than setting a fixed byte sequence.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The UConverter object. </td></tr>
<tr><td class="paramname">s</td><td>The Unicode string. </td></tr>
<tr><td class="paramname">length</td><td>The number of UChars in s, or -1 for a NUL-terminated string. </td></tr>
<tr><td class="paramname">err</td><td>Pointer to a standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.)</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#ac160b1b44ac9b5124ec083810709603a" title="Sets the substitution chars when converting from unicode to a codepage. ">ucnv_setSubstChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a118a87477ffa827d00dd50727da02e31" title="Fills in the output parameter, subChars, with the substitution characters as multiple bytes...">ucnv_getSubstChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001492">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="ab1f96fe9de8e2ee39159f748a8d33a4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_setToUCallBack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> </td>
<td class="paramname"><em>newAction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>newContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#a92b936b684ecf81d0dc63229a27a7349">UConverterToUCallback</a> * </td>
<td class="paramname"><em>oldAction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"><em>oldContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the callback function used by the converter when an illegal or invalid sequence is found. </p>
<p>Context pointers are always owned by the caller. Predefined actions and contexts can be found in the <a class="el" href="ucnv__err_8h.html" title="C UConverter predefined error callbacks. ">ucnv_err.h</a> header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the unicode converter </td></tr>
<tr><td class="paramname">newAction</td><td>the new callback function </td></tr>
<tr><td class="paramname">newContext</td><td>the new toUnicode callback context pointer. This can be NULL. </td></tr>
<tr><td class="paramname">oldAction</td><td>fillin: returns the old callback function pointer. This can be NULL. </td></tr>
<tr><td class="paramname">oldContext</td><td>fillin: returns the old callback's private void* context. This can be NULL. </td></tr>
<tr><td class="paramname">err</td><td>The error code status </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#af45faec39053767f4a7a779586c24223" title="Gets the current calback function used by the converter when an illegal or invalid codepage sequence ...">ucnv_getToUCallBack</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001511">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1b619c24f88f8b10f97b64ab1dc4fc86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_toAlgorithmic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#adb0b44c6bd828c9d4cc2defcbba0f902">UConverterType</a> </td>
<td class="paramname"><em>algorithmicType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from one external charset to another. </p>
<p>Internally, the text is converted to and from the 16-bit Unicode "pivot" using <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a>. <a class="el" href="ucnv_8h.html#a1b619c24f88f8b10f97b64ab1dc4fc86" title="Convert from one external charset to another. ">ucnv_toAlgorithmic()</a> works exactly like <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a> except that the two converters need not be looked up and opened completely.</p>
<p>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.</p>
<p>Internally, the algorithmic converter is opened and closed for each function call, which is more efficient than using the public <a class="el" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a C string...">ucnv_open()</a> but somewhat less efficient than only resetting an existing converter and using <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a>.</p>
<p>This function is more convenient than <a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx()</a> 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 <a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert()</a> for details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">algorithmicType</td><td>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. </td></tr>
<tr><td class="paramname">cnv</td><td>The converter that is used to convert from the source to the UTF-16 pivot buffer. </td></tr>
<tr><td class="paramname">target</td><td>Pointer to the output buffer. </td></tr>
<tr><td class="paramname">targetCapacity</td><td>Capacity of the target, in bytes. </td></tr>
<tr><td class="paramname">source</td><td>Pointer to the input buffer. </td></tr>
<tr><td class="paramname">sourceLength</td><td>Length of the input text, in bytes </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Length of the complete output text in bytes, even if it exceeds the targetCapacity and a U_BUFFER_OVERFLOW_ERROR is set.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a5cd24dc4d6c2fbec8c6481309459b7d5" title="Convert from one external charset to another. ">ucnv_fromAlgorithmic</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#af4c967c5afa207d064c24e19256586b6" title="Convert from one external charset to another using two existing UConverters. ">ucnv_convertEx</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a4a1f09772549fbcd7dd782297212c19f" title="Converts an array of unicode characters to an array of codepage characters. ">ucnv_fromUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a1493c21231f237e6197c027229389ff8" title="Convert the codepage string into a Unicode string using an existing UConverter. ">ucnv_toUChars</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001520">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a1493c21231f237e6197c027229389ff8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_toUChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert the codepage string into a Unicode string using an existing UConverter. </p>
<p>The output string is NUL-terminated if possible.</p>
<p>This function is a more convenient but less powerful version of <a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode()</a>. It is only useful for whole strings, not for streaming conversion.</p>
<p>The maximum output buffer capacity required (barring output from callbacks) will be 2*srcLength (each char may be converted into a surrogate pair).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>the converter object to be used (<a class="el" href="ucnv_8h.html#a8711b61a6cd41d84cf522042b3aebaed" title="Resets the to-Unicode part of a converter state to the default state. ">ucnv_resetToUnicode()</a> will be called) </td></tr>
<tr><td class="paramname">src</td><td>the input codepage string </td></tr>
<tr><td class="paramname">srcLength</td><td>the input string length, or -1 if NUL-terminated </td></tr>
<tr><td class="paramname">dest</td><td>destination string buffer, can be NULL if destCapacity==0 </td></tr>
<tr><td class="paramname">destCapacity</td><td>the number of UChars available at dest </td></tr>
<tr><td class="paramname">pErrorCode</td><td>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 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>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 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#afbea5eb35a5ec1517a548ffc868a5599" title="Converts a buffer of codepage bytes into an array of unicode UChars characters. ">ucnv_toUnicode</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001516">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a607e2305f45490a01fd8a32261e32e0c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucnv_toUCountPending </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of chars held in the converter's internal state because more input is needed for completing the conversion. </p>
<p>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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter in which the input is held as internal state </td></tr>
<tr><td class="paramname">status</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of chars in the state. -1 if an error is encountered. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001542">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="afbea5eb35a5ec1517a548ffc868a5599"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucnv_toUnicode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>converter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> ** </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>targetLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sourceLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>offsets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a buffer of codepage bytes into an array of unicode UChars characters. </p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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.)</p>
<p>This is a <em>stateful</em> 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 <code>U_BUFFER_OVERFLOW_ERROR</code>, 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. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">converter</td><td>the Unicode converter </td></tr>
<tr><td class="paramname">target</td><td>I/O parameter. Input : Points to the beginning of the buffer to copy UChars into. Output : points to after the last UChar copied. </td></tr>
<tr><td class="paramname">targetLimit</td><td>the pointer just after the end of the <code>target</code> buffer </td></tr>
<tr><td class="paramname">source</td><td>I/O parameter, pointer to pointer to the source codepage buffer. </td></tr>
<tr><td class="paramname">sourceLimit</td><td>the pointer to the byte after the end of the source buffer </td></tr>
<tr><td class="paramname">offsets</td><td>if NULL is passed, nothing will happen to it, otherwise it needs to have the same number of allocated cells as <code>target</code>. Will fill in offsets from target to source pointer e.g: <code>offsets[3]</code> is equal to 6, it means that the <code>target[3]</code> was a result of transcoding <code>source[6]</code> 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. </td></tr>
<tr><td class="paramname">flush</td><td>set to <code>TRUE</code> if the current source buffer is the last available chunk of the source, <code>FALSE</code> otherwise. Note that if a failing status is returned, this function may have to be called multiple times with flush set to <code>TRUE</code> until the source buffer is consumed. </td></tr>
<tr><td class="paramname">err</td><td>the error status. <code>U_ILLEGAL_ARGUMENT_ERROR</code> will be set if the converter is <code>NULL</code>. <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is still data to be written to the target. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter. ">ucnv_fromUChars</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a2bdb6b1d3ac4069808348eb6961ce63d" title="Convert from one external charset to another. ">ucnv_convert</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a12edd465a611c41e418632f5d5f2dbe4" title="Returns the minimum byte length (per codepoint) for characters in this codepage. ">ucnv_getMinCharSize</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#a59fdaf2cf5dc57d738ed7a7657f6b03a" title="Changes the current callback function used by the converter when an illegal or invalid sequence is fo...">ucnv_setFromUCallBack</a> </dd>
<dd>
<a class="el" href="ucnv_8h.html#aaf391b89870fd88b3da838eff1bd6ba6" title="Convert a codepage buffer into Unicode one character at a time. ">ucnv_getNextUChar</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001514">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a036433918c08965c4c687892036db3eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucnv_usesFallback </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> * </td>
<td class="paramname"><em>cnv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the converter uses fallback mappings or not. </p>
<p>This flag has restrictions, see <a class="el" href="ucnv_8h.html#a117c45b5c1d746c6f532f44985b686e4" title="Sets the converter to use fallback mappings or not. ">ucnv_setFallback()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>The converter to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the converter uses fallback, FALSE otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001539">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucnv_8h.html#a117c45b5c1d746c6f532f44985b686e4" title="Sets the converter to use fallback mappings or not. ">ucnv_setFallback</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
945
