<!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: utrans.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_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#namespaces">Namespaces</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">utrans.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Transliterator.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br />
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br />
<code>#include "<a class="el" href="urep_8h_source.html">unicode/urep.h</a>"</code><br />
<code>#include "<a class="el" href="parseerr_8h_source.html">unicode/parseerr.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="uset_8h_source.html">unicode/uset.h</a>"</code><br />
</div>
<p><a href="utrans_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUTransPosition.html">UTransPosition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Position structure for <a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental()</a> incremental transliteration. <a href="structUTransPosition.html#details">More...</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="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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1230b61c2370123b3f17d88dcdc13154"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a></td></tr>
<tr class="memdesc:a1230b61c2370123b3f17d88dcdc13154"><td class="mdescLeft"> </td><td class="mdescRight">An opaque transliterator for use in C. <a href="#a1230b61c2370123b3f17d88dcdc13154">More...</a><br /></td></tr>
<tr class="separator:a1230b61c2370123b3f17d88dcdc13154"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06661b36935c0a95c9f68ef325509046"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a06661b36935c0a95c9f68ef325509046">UTransDirection</a></td></tr>
<tr class="memdesc:a06661b36935c0a95c9f68ef325509046"><td class="mdescLeft"> </td><td class="mdescRight">Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. <a href="#a06661b36935c0a95c9f68ef325509046">More...</a><br /></td></tr>
<tr class="separator:a06661b36935c0a95c9f68ef325509046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59df3ae30c9336a6ed2748b5fb0c56d1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structUTransPosition.html">UTransPosition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a59df3ae30c9336a6ed2748b5fb0c56d1">UTransPosition</a></td></tr>
<tr class="memdesc:a59df3ae30c9336a6ed2748b5fb0c56d1"><td class="mdescLeft"> </td><td class="mdescRight">Position structure for <a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental()</a> incremental transliteration. <a href="#a59df3ae30c9336a6ed2748b5fb0c56d1">More...</a><br /></td></tr>
<tr class="separator:a59df3ae30c9336a6ed2748b5fb0c56d1"><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:a04f480e9e8e40f0d8067521668dc06ec"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> { <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06eca112cbaa326ae590fb91ecd99839b6f5f">UTRANS_FORWARD</a>,
<a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06eca5e10b16d78c21a0df70390998e488c32">UTRANS_REVERSE</a>
}<tr class="memdesc:a04f480e9e8e40f0d8067521668dc06ec"><td class="mdescLeft"> </td><td class="mdescRight">Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. <a href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a04f480e9e8e40f0d8067521668dc06ec"><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:a014170af31c08e811a61c6b4109b20c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a014170af31c08e811a61c6b4109b20c9">utrans_openU</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id, int32_t idLength, <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> dir, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *rules, int32_t rulesLength, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a014170af31c08e811a61c6b4109b20c9"><td class="mdescLeft"> </td><td class="mdescRight">Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. <a href="#a014170af31c08e811a61c6b4109b20c9">More...</a><br /></td></tr>
<tr class="separator:a014170af31c08e811a61c6b4109b20c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9dbdef3ebe320c3e4da826af27ca8bf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a9dbdef3ebe320c3e4da826af27ca8bf5">utrans_openInverse</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a9dbdef3ebe320c3e4da826af27ca8bf5"><td class="mdescLeft"> </td><td class="mdescRight">Open an inverse of an existing transliterator. <a href="#a9dbdef3ebe320c3e4da826af27ca8bf5">More...</a><br /></td></tr>
<tr class="separator:a9dbdef3ebe320c3e4da826af27ca8bf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac271881fd04dff0dc71bc1d25c807fae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#ac271881fd04dff0dc71bc1d25c807fae">utrans_clone</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac271881fd04dff0dc71bc1d25c807fae"><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of a transliterator. <a href="#ac271881fd04dff0dc71bc1d25c807fae">More...</a><br /></td></tr>
<tr class="separator:ac271881fd04dff0dc71bc1d25c807fae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a148066969cc61b36a8cbcc76f7dd02f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8">utrans_close</a> (<a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans)</td></tr>
<tr class="memdesc:a148066969cc61b36a8cbcc76f7dd02f8"><td class="mdescLeft"> </td><td class="mdescRight">Close a transliterator. <a href="#a148066969cc61b36a8cbcc76f7dd02f8">More...</a><br /></td></tr>
<tr class="separator:a148066969cc61b36a8cbcc76f7dd02f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f2aa5ab7f6dd0fb220602db34975367"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a1f2aa5ab7f6dd0fb220602db34975367">utrans_getUnicodeID</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, int32_t *resultLength)</td></tr>
<tr class="memdesc:a1f2aa5ab7f6dd0fb220602db34975367"><td class="mdescLeft"> </td><td class="mdescRight">Return the programmatic identifier for this transliterator. <a href="#a1f2aa5ab7f6dd0fb220602db34975367">More...</a><br /></td></tr>
<tr class="separator:a1f2aa5ab7f6dd0fb220602db34975367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d456df4a9bffef39f2a209283b30c4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a1d456df4a9bffef39f2a209283b30c4d">utrans_register</a> (<a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *adoptedTrans, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1d456df4a9bffef39f2a209283b30c4d"><td class="mdescLeft"> </td><td class="mdescRight">Register an open transliterator with the system. <a href="#a1d456df4a9bffef39f2a209283b30c4d">More...</a><br /></td></tr>
<tr class="separator:a1d456df4a9bffef39f2a209283b30c4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ee706f8cfbda8f7efbd844415700c74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a6ee706f8cfbda8f7efbd844415700c74">utrans_unregisterID</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id, int32_t idLength)</td></tr>
<tr class="memdesc:a6ee706f8cfbda8f7efbd844415700c74"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a transliterator from the system. <a href="#a6ee706f8cfbda8f7efbd844415700c74">More...</a><br /></td></tr>
<tr class="separator:a6ee706f8cfbda8f7efbd844415700c74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2523d2f0eb13e3011980cb9d9d0bfa0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#aa2523d2f0eb13e3011980cb9d9d0bfa0">utrans_setFilter</a> (<a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *filterPattern, int32_t filterPatternLen, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa2523d2f0eb13e3011980cb9d9d0bfa0"><td class="mdescLeft"> </td><td class="mdescRight">Set the filter used by a transliterator. <a href="#aa2523d2f0eb13e3011980cb9d9d0bfa0">More...</a><br /></td></tr>
<tr class="separator:aa2523d2f0eb13e3011980cb9d9d0bfa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9153da8ece577f232fd2a48d4c412577"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a9153da8ece577f232fd2a48d4c412577">utrans_countAvailableIDs</a> (void)</td></tr>
<tr class="memdesc:a9153da8ece577f232fd2a48d4c412577"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of system transliterators. <a href="#a9153da8ece577f232fd2a48d4c412577">More...</a><br /></td></tr>
<tr class="separator:a9153da8ece577f232fd2a48d4c412577"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a489c970cc731dac45c3bb5cced4ccb52"><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="utrans_8h.html#a489c970cc731dac45c3bb5cced4ccb52">utrans_openIDs</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a489c970cc731dac45c3bb5cced4ccb52"><td class="mdescLeft"> </td><td class="mdescRight">Return a UEnumeration for the available transliterators. <a href="#a489c970cc731dac45c3bb5cced4ccb52">More...</a><br /></td></tr>
<tr class="separator:a489c970cc731dac45c3bb5cced4ccb52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a183f6e0cd5b9ef82f3be82c1f6a1b20a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a183f6e0cd5b9ef82f3be82c1f6a1b20a">utrans_trans</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a> *rep, <a class="el" href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a> *repFunc, int32_t start, int32_t *limit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a183f6e0cd5b9ef82f3be82c1f6a1b20a"><td class="mdescLeft"> </td><td class="mdescRight">Transliterate a segment of a UReplaceable string. <a href="#a183f6e0cd5b9ef82f3be82c1f6a1b20a">More...</a><br /></td></tr>
<tr class="separator:a183f6e0cd5b9ef82f3be82c1f6a1b20a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac22b8fe64729a6c99d750020946adad2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2">utrans_transIncremental</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a> *rep, <a class="el" href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a> *repFunc, <a class="el" href="structUTransPosition.html">UTransPosition</a> *pos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac22b8fe64729a6c99d750020946adad2"><td class="mdescLeft"> </td><td class="mdescRight">Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly. <a href="#ac22b8fe64729a6c99d750020946adad2">More...</a><br /></td></tr>
<tr class="separator:ac22b8fe64729a6c99d750020946adad2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af415d8aa51e79d4494ebb8ef8fc76ae2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#af415d8aa51e79d4494ebb8ef8fc76ae2">utrans_transUChars</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t *textLength, int32_t textCapacity, int32_t start, int32_t *limit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:af415d8aa51e79d4494ebb8ef8fc76ae2"><td class="mdescLeft"> </td><td class="mdescRight">Transliterate a segment of a UChar* string. <a href="#af415d8aa51e79d4494ebb8ef8fc76ae2">More...</a><br /></td></tr>
<tr class="separator:af415d8aa51e79d4494ebb8ef8fc76ae2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c1e78cfd3e397ea4d8218b4e2572735"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a9c1e78cfd3e397ea4d8218b4e2572735">utrans_transIncrementalUChars</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t *textLength, int32_t textCapacity, <a class="el" href="structUTransPosition.html">UTransPosition</a> *pos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a9c1e78cfd3e397ea4d8218b4e2572735"><td class="mdescLeft"> </td><td class="mdescRight">Transliterate the portion of the UChar* text buffer that can be transliterated unambiguosly. <a href="#a9c1e78cfd3e397ea4d8218b4e2572735">More...</a><br /></td></tr>
<tr class="separator:a9c1e78cfd3e397ea4d8218b4e2572735"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f32d9fd8ca61f0677432832b1580907"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a1f32d9fd8ca61f0677432832b1580907">utrans_toRules</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> escapeUnprintable, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *result, int32_t resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1f32d9fd8ca61f0677432832b1580907"><td class="mdescLeft"> </td><td class="mdescRight">Create a rule string that can be passed to utrans_openU to recreate this transliterator. <a href="#a1f32d9fd8ca61f0677432832b1580907">More...</a><br /></td></tr>
<tr class="separator:a1f32d9fd8ca61f0677432832b1580907"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a274b8e91d9d9a754a352cf968d6e5b95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a274b8e91d9d9a754a352cf968d6e5b95">utrans_getSourceSet</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ignoreFilter, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *fillIn, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a274b8e91d9d9a754a352cf968d6e5b95"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of all characters that may be modified in the input text by this UTransliterator, optionally ignoring the transliterator's current filter. <a href="#a274b8e91d9d9a754a352cf968d6e5b95">More...</a><br /></td></tr>
<tr class="separator:a274b8e91d9d9a754a352cf968d6e5b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afaa9d751e1d24617ba1071d8d4c887a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#afaa9d751e1d24617ba1071d8d4c887a3">utrans_open</a> (const char *id, <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> dir, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *rules, int32_t rulesLength, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:afaa9d751e1d24617ba1071d8d4c887a3"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated, use <a class="el" href="utrans_8h.html#a014170af31c08e811a61c6b4109b20c9" title="Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. ">utrans_openU()</a> instead. <a href="#afaa9d751e1d24617ba1071d8d4c887a3">More...</a><br /></td></tr>
<tr class="separator:afaa9d751e1d24617ba1071d8d4c887a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5820268446001f80e9cc5fd8c5dc3399"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a5820268446001f80e9cc5fd8c5dc3399">utrans_getID</a> (const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> *trans, char *buf, int32_t bufCapacity)</td></tr>
<tr class="memdesc:a5820268446001f80e9cc5fd8c5dc3399"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated, use <a class="el" href="utrans_8h.html#a1f2aa5ab7f6dd0fb220602db34975367" title="Return the programmatic identifier for this transliterator. ">utrans_getUnicodeID()</a> instead. <a href="#a5820268446001f80e9cc5fd8c5dc3399">More...</a><br /></td></tr>
<tr class="separator:a5820268446001f80e9cc5fd8c5dc3399"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71b5c2733100e28705a87aa68a99e469"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a71b5c2733100e28705a87aa68a99e469">utrans_unregister</a> (const char *id)</td></tr>
<tr class="memdesc:a71b5c2733100e28705a87aa68a99e469"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated, use <a class="el" href="utrans_8h.html#a6ee706f8cfbda8f7efbd844415700c74" title="Unregister a transliterator from the system. ">utrans_unregisterID()</a> instead. <a href="#a71b5c2733100e28705a87aa68a99e469">More...</a><br /></td></tr>
<tr class="separator:a71b5c2733100e28705a87aa68a99e469"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ba86b3ce05c45b22b53cdc718266223"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrans_8h.html#a7ba86b3ce05c45b22b53cdc718266223">utrans_getAvailableID</a> (int32_t index, char *buf, int32_t bufCapacity)</td></tr>
<tr class="memdesc:a7ba86b3ce05c45b22b53cdc718266223"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated, use <a class="el" href="utrans_8h.html#a489c970cc731dac45c3bb5cced4ccb52" title="Return a UEnumeration for the available transliterators. ">utrans_openIDs()</a> instead. <a href="#a7ba86b3ce05c45b22b53cdc718266223">More...</a><br /></td></tr>
<tr class="separator:a7ba86b3ce05c45b22b53cdc718266223"><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: Transliterator. </p>
<h2>Transliteration </h2>
<p>The data structures and functions described in this header provide transliteration services. Transliteration services are implemented as C++ classes. The comments and documentation in this header assume the reader is familiar with the C++ headers <a class="el" href="translit_8h.html" title="C++ API: Tranforms text from one format to another. ">translit.h</a> and associated documentation.</p>
<p>A significant but incomplete subset of the C++ transliteration services are available to C code through this header. In order to access more complex transliteration services, refer to the C++ headers and documentation.</p>
<p>There are two sets of functions for working with transliterator IDs:</p>
<p>An old, deprecated set uses char * IDs, which works for true and pure identifiers that these APIs were designed for, for example "Cyrillic-Latin". It does not work when the ID contains filters ("[:Script=Cyrl:]") or even a complete set of rules because then the ID string contains more than just "invariant" characters (see <a class="el" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs. ">utypes.h</a>).</p>
<p>A new set of functions replaces the old ones and uses UChar * IDs, paralleling the UnicodeString IDs in the C++ API. (New in ICU 2.8.) </p>
<p>Definition in file <a class="el" href="utrans_8h_source.html">utrans.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a06661b36935c0a95c9f68ef325509046"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. </p>
<p>Specified when a transliterator is opened. An "A-B" transliterator transliterates A to B when operating in the forward direction, and B to A when operating in the reverse direction. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable005619">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1230b61c2370123b3f17d88dcdc13154"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque transliterator for use in C. </p>
<p>Open with utrans_openxxx() and close with <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a> when done. Equivalent to the C++ class Transliterator and its subclasses. </p><dl class="section see"><dt>See also</dt><dd>Transliterator </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005618">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="utrans_8h_source.html#l00070">70</a> of file <a class="el" href="utrans_8h_source.html">utrans.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59df3ae30c9336a6ed2748b5fb0c56d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structUTransPosition.html">UTransPosition</a> <a class="el" href="structUTransPosition.html">UTransPosition</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Position structure for <a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental()</a> incremental transliteration. </p>
<p>This structure defines two substrings of the text being transliterated. The first region, [contextStart, contextLimit), defines what characters the transliterator will read as context. The second region, [start, limit), defines what characters will actually be transliterated. The second region should be a subset of the first.</p>
<p>After a transliteration operation, some of the indices in this structure will be modified. See the field descriptions for details.</p>
<p>contextStart <= start <= limit <= contextLimit</p>
<p>Note: All index values in this structure must be at code point boundaries. That is, none of them may occur between two code units of a surrogate pair. If any index does split a surrogate pair, results are unspecified.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005620">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a04f480e9e8e40f0d8067521668dc06ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. </p>
<p>Specified when a transliterator is opened. An "A-B" transliterator transliterates A to B when operating in the forward direction, and B to A when operating in the reverse direction. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable005619">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="a04f480e9e8e40f0d8067521668dc06eca112cbaa326ae590fb91ecd99839b6f5f"></a>UTRANS_FORWARD </td><td class="fielddoc">
<p>UTRANS_FORWARD means from <source> to <target> for a transliterator with ID <source>-<target>. </p>
<p>For a transliterator opened using a rule, it means forward direction rules, e.g., "A > B". </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a04f480e9e8e40f0d8067521668dc06eca5e10b16d78c21a0df70390998e488c32"></a>UTRANS_REVERSE </td><td class="fielddoc">
<p>UTRANS_REVERSE means from <target> to <source> for a transliterator with ID <source>-<target>. </p>
<p>For a transliterator opened using a rule, it means reverse direction rules, e.g., "A < B". </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="utrans_8h_source.html#l00080">80</a> of file <a class="el" href="utrans_8h_source.html">utrans.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac271881fd04dff0dc71bc1d25c807fae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a>* utrans_clone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>Create a copy of a transliterator. </p>
<p>Any non-NULL result from this function should later be closed with <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator to be copied. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the clone call fails. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005623">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a148066969cc61b36a8cbcc76f7dd02f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a transliterator. </p>
<p>Any non-NULL pointer returned by utrans_openXxx() or <a class="el" href="utrans_8h.html#ac271881fd04dff0dc71bc1d25c807fae" title="Create a copy of a transliterator. ">utrans_clone()</a> should eventually be closed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator to be closed. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005624">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9153da8ece577f232fd2a48d4c412577"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrans_countAvailableIDs </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of system transliterators. </p>
<p>It is recommended to use <a class="el" href="utrans_8h.html#a489c970cc731dac45c3bb5cced4ccb52" title="Return a UEnumeration for the available transliterators. ">utrans_openIDs()</a> instead.</p>
<dl class="section return"><dt>Returns</dt><dd>the number of system transliterators. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005629">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7ba86b3ce05c45b22b53cdc718266223"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrans_getAvailableID </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>bufCapacity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated, use <a class="el" href="utrans_8h.html#a489c970cc731dac45c3bb5cced4ccb52" title="Return a UEnumeration for the available transliterators. ">utrans_openIDs()</a> instead. </p>
<p>Return the ID of the index-th system transliterator. The result is placed in the given buffer. If the given buffer is too small, the initial substring is copied to buf. The result in buf is always zero-terminated.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>the number of the transliterator to return. Must satisfy 0 <= index < <a class="el" href="utrans_8h.html#a9153da8ece577f232fd2a48d4c412577" title="Return the number of system transliterators. ">utrans_countAvailableIDs()</a>. If index is out of range then it is treated as if it were 0. </td></tr>
<tr><td class="paramname">buf</td><td>the buffer in which to receive the ID. This may be NULL, in which case no characters are copied. </td></tr>
<tr><td class="paramname">bufCapacity</td><td>the capacity of the buffer. Ignored if buf is NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the actual length of the index-th ID, not including zero-termination. This may be greater than bufCapacity. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000440">Deprecated:</a></b></dt><dd>ICU 2.8 Use <a class="el" href="utrans_8h.html#a489c970cc731dac45c3bb5cced4ccb52" title="Return a UEnumeration for the available transliterators. ">utrans_openIDs()</a> instead, see <a class="el" href="utrans_8h.html" title="C API: Transliterator. ">utrans.h</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5820268446001f80e9cc5fd8c5dc3399"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrans_getID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>bufCapacity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated, use <a class="el" href="utrans_8h.html#a1f2aa5ab7f6dd0fb220602db34975367" title="Return the programmatic identifier for this transliterator. ">utrans_getUnicodeID()</a> instead. </p>
<p>Return the programmatic identifier for this transliterator. If this identifier is passed to <a class="el" href="utrans_8h.html#afaa9d751e1d24617ba1071d8d4c887a3" title="Deprecated, use utrans_openU() instead. ">utrans_open()</a>, it will open a transliterator equivalent to this one, if the ID has been registered. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator to return the ID of. </td></tr>
<tr><td class="paramname">buf</td><td>the buffer in which to receive the ID. This may be NULL, in which case no characters are copied. </td></tr>
<tr><td class="paramname">bufCapacity</td><td>the capacity of the buffer. Ignored if buf is NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the actual length of the ID, not including zero-termination. This may be greater than bufCapacity. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000438">Deprecated:</a></b></dt><dd>ICU 2.8 Use <a class="el" href="utrans_8h.html#a1f2aa5ab7f6dd0fb220602db34975367" title="Return the programmatic identifier for this transliterator. ">utrans_getUnicodeID()</a> instead, see <a class="el" href="utrans_8h.html" title="C API: Transliterator. ">utrans.h</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a274b8e91d9d9a754a352cf968d6e5b95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* utrans_getSourceSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>ignoreFilter</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>fillIn</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 set of all characters that may be modified in the input text by this UTransliterator, optionally ignoring the transliterator's current filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>The transliterator. </td></tr>
<tr><td class="paramname">ignoreFilter</td><td>If FALSE, the returned set incorporates the UTransliterator's current filter; if the filter is changed, the return value of this function will change. If TRUE, the returned set ignores the effect of the UTransliterator's current filter. </td></tr>
<tr><td class="paramname">fillIn</td><td>Pointer to a USet object to receive the modifiable characters set. Previous contents of fillIn are lost. <em>If fillIn is NULL, then a new USet is created and returned. The caller owns the result and must dispose of it by calling uset_close.</em> </td></tr>
<tr><td class="paramname">status</td><td>A pointer to the UErrorCode. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>USet* Either fillIn, or if fillIn is NULL, a pointer to a newly-allocated USet that the user must close. In case of error, NULL is returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005636">Stable:</a></b></dt><dd>ICU 53 </dd></dl>
</div>
</div>
<a class="anchor" id="a1f2aa5ab7f6dd0fb220602db34975367"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* utrans_getUnicodeID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>resultLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the programmatic identifier for this transliterator. </p>
<p>If this identifier is passed to <a class="el" href="utrans_8h.html#a014170af31c08e811a61c6b4109b20c9" title="Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. ">utrans_openU()</a>, it will open a transliterator equivalent to this one, if the ID has been registered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator to return the ID of. </td></tr>
<tr><td class="paramname">resultLength</td><td>pointer to an output variable receiving the length of the ID string; can be NULL </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the NUL-terminated ID string. This pointer remains valid until <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a> is called on this transliterator.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005625">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="afaa9d751e1d24617ba1071d8d4c887a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a>* utrans_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> </td>
<td class="paramname"><em>dir</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>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>rulesLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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>Deprecated, use <a class="el" href="utrans_8h.html#a014170af31c08e811a61c6b4109b20c9" title="Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. ">utrans_openU()</a> instead. </p>
<p>Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. Any non-NULL result from this function should later be closed with <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>a valid ID, as returned by <a class="el" href="utrans_8h.html#a7ba86b3ce05c45b22b53cdc718266223" title="Deprecated, use utrans_openIDs() instead. ">utrans_getAvailableID()</a> </td></tr>
<tr><td class="paramname">dir</td><td>the desired direction </td></tr>
<tr><td class="paramname">rules</td><td>the transliterator rules. See the C++ header rbt.h for rules syntax. If NULL then a system transliterator matching the ID is returned. </td></tr>
<tr><td class="paramname">rulesLength</td><td>the length of the rules, or -1 if the rules are zero-terminated. </td></tr>
<tr><td class="paramname">parseError</td><td>a pointer to a <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> struct to receive the details of any parsing errors. This parameter may be NULL if no parsing error details are desired. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the open call fails. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000437">Deprecated:</a></b></dt><dd>ICU 2.8 Use <a class="el" href="utrans_8h.html#a014170af31c08e811a61c6b4109b20c9" title="Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. ">utrans_openU()</a> instead, see <a class="el" href="utrans_8h.html" title="C API: Transliterator. ">utrans.h</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a489c970cc731dac45c3bb5cced4ccb52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* utrans_openIDs </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>Return a UEnumeration for the available transliterators. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pErrorCode</td><td>Pointer to the UErrorCode in/out parameter. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>UEnumeration for the available transliterators. Close with <a class="el" href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df" title="Disposes of resources in use by the iterator. ">uenum_close()</a>.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005630">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a9dbdef3ebe320c3e4da826af27ca8bf5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a>* utrans_openInverse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>Open an inverse of an existing transliterator. </p>
<p>For this to work, the inverse must be registered with the system. For example, if the Transliterator "A-B" is opened, and then its inverse is opened, the result is the Transliterator "B-A", if such a transliterator is registered with the system. Otherwise the result is NULL and a failing UErrorCode is set. Any non-NULL result from this function should later be closed with <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator to open the inverse of. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a newly-opened transliterator that is the inverse of trans, or NULL if the open call fails. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005622">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a014170af31c08e811a61c6b4109b20c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a>* utrans_openU </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>idLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">UTransDirection</a> </td>
<td class="paramname"><em>dir</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>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>rulesLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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>Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. </p>
<p>Any non-NULL result from this function should later be closed with <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>a valid transliterator ID </td></tr>
<tr><td class="paramname">idLength</td><td>the length of the ID string, or -1 if NUL-terminated </td></tr>
<tr><td class="paramname">dir</td><td>the desired direction </td></tr>
<tr><td class="paramname">rules</td><td>the transliterator rules. See the C++ header rbt.h for rules syntax. If NULL then a system transliterator matching the ID is returned. </td></tr>
<tr><td class="paramname">rulesLength</td><td>the length of the rules, or -1 if the rules are NUL-terminated. </td></tr>
<tr><td class="paramname">parseError</td><td>a pointer to a <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> struct to receive the details of any parsing errors. This parameter may be NULL if no parsing error details are desired. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the open call fails. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005621">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a1d456df4a9bffef39f2a209283b30c4d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>adoptedTrans</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>Register an open transliterator with the system. </p>
<p>When <a class="el" href="utrans_8h.html#afaa9d751e1d24617ba1071d8d4c887a3" title="Deprecated, use utrans_openU() instead. ">utrans_open()</a> is called with an ID string that is equal to that returned by utrans_getID(adoptedTrans,...), then utrans_clone(adoptedTrans,...) is returned.</p>
<p>NOTE: After this call the system owns the adoptedTrans and will close it. The user must not call <a class="el" href="utrans_8h.html#a148066969cc61b36a8cbcc76f7dd02f8" title="Close a transliterator. ">utrans_close()</a> on adoptedTrans.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adoptedTrans</td><td>a transliterator, typically the result of utrans_openRules(), to be registered with the system. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005626">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa2523d2f0eb13e3011980cb9d9d0bfa0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_setFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>filterPattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>filterPatternLen</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>Set the filter used by a transliterator. </p>
<p>A filter can be used to make the transliterator pass certain characters through untouched. The filter is expressed using a UnicodeSet pattern. If the filterPattern is NULL or the empty string, then the transliterator will be reset to use no filter.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator </td></tr>
<tr><td class="paramname">filterPattern</td><td>a pattern string, in the form accepted by UnicodeSet, specifying which characters to apply the transliteration to. May be NULL or the empty string to indicate no filter. </td></tr>
<tr><td class="paramname">filterPatternLen</td><td>the length of filterPattern, or -1 if filterPattern is zero-terminated </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>UnicodeSet </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005628">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1f32d9fd8ca61f0677432832b1580907"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrans_toRules </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>escapeUnprintable</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>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</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>Create a rule string that can be passed to utrans_openU to recreate this transliterator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>The transliterator </td></tr>
<tr><td class="paramname">escapeUnprintable</td><td>if TRUE then convert unprintable characters to their hex escape representations, \uxxxx or \Uxxxxxxxx. Unprintable characters are those other than U+000A, U+0020..U+007E. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the rules. </td></tr>
<tr><td class="paramname">resultLength</td><td>The maximum size of result. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to the UErrorCode. In case of error status, the contents of result are undefined. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int32_t The length of the rule string (may be greater than resultLength, in which case an error is returned). </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005635">Stable:</a></b></dt><dd>ICU 53 </dd></dl>
</div>
</div>
<a class="anchor" id="a183f6e0cd5b9ef82f3be82c1f6a1b20a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_trans </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a> * </td>
<td class="paramname"><em>rep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a> * </td>
<td class="paramname"><em>repFunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>limit</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>Transliterate a segment of a UReplaceable string. </p>
<p>The string is passed in as a UReplaceable pointer rep and a <a class="el" href="structUReplaceableCallbacks.html" title="A set of function pointers that transliterators use to manipulate a UReplaceable. ...">UReplaceableCallbacks</a> function pointer struct repFunc. Functions in the repFunc struct will be called in order to modify the rep string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator </td></tr>
<tr><td class="paramname">rep</td><td>a pointer to the string. This will be passed to the repFunc functions. </td></tr>
<tr><td class="paramname">repFunc</td><td>a set of function pointers that will be used to modify the string pointed to by rep. </td></tr>
<tr><td class="paramname">start</td><td>the beginning index, inclusive; <code>0 <= start <= limit</code>. </td></tr>
<tr><td class="paramname">limit</td><td>pointer to the ending index, exclusive; <code>start <= limit <= repFunc->length(rep)</code>. Upon return, *limit will contain the new limit index. The text previously occupying <code>[start, limit)</code> has been transliterated, possibly to a string of a different length, at <code>[start, </code><em>new-limit</em><code>)</code>, where <em>new-limit</em> is the return value. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005631">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac22b8fe64729a6c99d750020946adad2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_transIncremental </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a> * </td>
<td class="paramname"><em>rep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a> * </td>
<td class="paramname"><em>repFunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUTransPosition.html">UTransPosition</a> * </td>
<td class="paramname"><em>pos</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>Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly. </p>
<p>This method is typically called after new text has been inserted, e.g. as a result of a keyboard event. The transliterator will try to transliterate characters of <code>rep</code> between <code>index.cursor</code> and <code>index.limit</code>. Characters before <code>index.cursor</code> will not be changed.</p>
<p>Upon return, values in <code>index</code> will be updated. <code>index.start</code> will be advanced to the first character that future calls to this method will read. <code>index.cursor</code> and <code>index.limit</code> will be adjusted to delimit the range of text that future calls to this method may change.</p>
<p>Typical usage of this method begins with an initial call with <code>index.start</code> and <code>index.limit</code> set to indicate the portion of <code>text</code> to be transliterated, and <code>index.cursor == index.start</code>. Thereafter, <code>index</code> can be used without modification in future calls, provided that all changes to <code>text</code> are made via this method.</p>
<p>This method assumes that future calls may be made that will insert new text into the buffer. As a result, it only performs unambiguous transliterations. After the last call to this method, there may be untransliterated text that is waiting for more input to resolve an ambiguity. In order to perform these pending transliterations, clients should call <a class="el" href="utrans_8h.html#a183f6e0cd5b9ef82f3be82c1f6a1b20a" title="Transliterate a segment of a UReplaceable string. ">utrans_trans()</a> with a start of index.start and a limit of index.end after the last call to this method has been made.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator </td></tr>
<tr><td class="paramname">rep</td><td>a pointer to the string. This will be passed to the repFunc functions. </td></tr>
<tr><td class="paramname">repFunc</td><td>a set of function pointers that will be used to modify the string pointed to by rep. </td></tr>
<tr><td class="paramname">pos</td><td>a struct containing the start and limit indices of the text to be read and the text to be transliterated </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005632">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9c1e78cfd3e397ea4d8218b4e2572735"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_transIncrementalUChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>textCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUTransPosition.html">UTransPosition</a> * </td>
<td class="paramname"><em>pos</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>Transliterate the portion of the UChar* text buffer that can be transliterated unambiguosly. </p>
<p>See <a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental()</a>. The string is passed in in a UChar* buffer. The string is modified in place. If the result is longer than textCapacity, it is truncated. The actual length of the result is returned in *textLength, if textLength is non-NULL. *textLength may be greater than textCapacity, but only textCapacity UChars will be written to *text, including the zero terminator. See <a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental()</a> for usage details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator </td></tr>
<tr><td class="paramname">text</td><td>a pointer to a buffer containing the text to be transliterated on input and the result text on output. </td></tr>
<tr><td class="paramname">textLength</td><td>a pointer to the length of the string in text. If the length is -1 then the string is assumed to be zero-terminated. Upon return, the new length is stored in *textLength. If textLength is NULL then the string is assumed to be zero-terminated. </td></tr>
<tr><td class="paramname">textCapacity</td><td>the length of the text buffer </td></tr>
<tr><td class="paramname">pos</td><td>a struct containing the start and limit indices of the text to be read and the text to be transliterated </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly...">utrans_transIncremental</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005634">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af415d8aa51e79d4494ebb8ef8fc76ae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_transUChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="utrans_8h.html#a1230b61c2370123b3f17d88dcdc13154">UTransliterator</a> * </td>
<td class="paramname"><em>trans</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>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>textCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>limit</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>Transliterate a segment of a UChar* string. </p>
<p>The string is passed in in a UChar* buffer. The string is modified in place. If the result is longer than textCapacity, it is truncated. The actual length of the result is returned in *textLength, if textLength is non-NULL. *textLength may be greater than textCapacity, but only textCapacity UChars will be written to *text, including the zero terminator.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trans</td><td>the transliterator </td></tr>
<tr><td class="paramname">text</td><td>a pointer to a buffer containing the text to be transliterated on input and the result text on output. </td></tr>
<tr><td class="paramname">textLength</td><td>a pointer to the length of the string in text. If the length is -1 then the string is assumed to be zero-terminated. Upon return, the new length is stored in *textLength. If textLength is NULL then the string is assumed to be zero-terminated. </td></tr>
<tr><td class="paramname">textCapacity</td><td>a pointer to the length of the text buffer. Upon return, </td></tr>
<tr><td class="paramname">start</td><td>the beginning index, inclusive; <code>0 <= start <= limit</code>. </td></tr>
<tr><td class="paramname">limit</td><td>pointer to the ending index, exclusive; <code>start <= limit <= repFunc->length(rep)</code>. Upon return, *limit will contain the new limit index. The text previously occupying <code>[start, limit)</code> has been transliterated, possibly to a string of a different length, at <code>[start, </code><em>new-limit</em><code>)</code>, where <em>new-limit</em> is the return value. </td></tr>
<tr><td class="paramname">status</td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005633">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a71b5c2733100e28705a87aa68a99e469"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_unregister </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated, use <a class="el" href="utrans_8h.html#a6ee706f8cfbda8f7efbd844415700c74" title="Unregister a transliterator from the system. ">utrans_unregisterID()</a> instead. </p>
<p>Unregister a transliterator from the system. After this call the system will no longer recognize the given ID when passed to <a class="el" href="utrans_8h.html#afaa9d751e1d24617ba1071d8d4c887a3" title="Deprecated, use utrans_openU() instead. ">utrans_open()</a>. If the id is invalid then nothing is done.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>a zero-terminated ID </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000439">Deprecated:</a></b></dt><dd>ICU 2.8 Use <a class="el" href="utrans_8h.html#a6ee706f8cfbda8f7efbd844415700c74" title="Unregister a transliterator from the system. ">utrans_unregisterID()</a> instead, see <a class="el" href="utrans_8h.html" title="C API: Transliterator. ">utrans.h</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6ee706f8cfbda8f7efbd844415700c74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrans_unregisterID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>idLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister a transliterator from the system. </p>
<p>After this call the system will no longer recognize the given ID when passed to <a class="el" href="utrans_8h.html#afaa9d751e1d24617ba1071d8d4c887a3" title="Deprecated, use utrans_openU() instead. ">utrans_open()</a>. If the ID is invalid then nothing is done.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>an ID to unregister </td></tr>
<tr><td class="paramname">idLength</td><td>the length of id, or -1 if id is zero-terminated </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005627">Stable:</a></b></dt><dd>ICU 2.8 </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
>
1072
