<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: utrans.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>utrans.h File Reference</h1>
<p>C API: <a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a>.
<a href="#_details">More...</a></p>
<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/>
<p><a href="utrans_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><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><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...">utrans_transIncremental()</a> incremental transliteration. <a href="structUTransPosition.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">An opaque transliterator for use in C. <a href="#a1230b61c2370123b3f17d88dcdc13154"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><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>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. </p>
<a href="utrans_8h.html#a04f480e9e8e40f0d8067521668dc06ec">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Open an inverse of an existing transliterator. <a href="#a9dbdef3ebe320c3e4da826af27ca8bf5"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of a transliterator. <a href="#ac271881fd04dff0dc71bc1d25c807fae"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Close a transliterator. <a href="#a148066969cc61b36a8cbcc76f7dd02f8"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Return the programmatic identifier for this transliterator. <a href="#a1f2aa5ab7f6dd0fb220602db34975367"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Register an open transliterator with the system. <a href="#a1d456df4a9bffef39f2a209283b30c4d"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Unregister a transliterator from the system. <a href="#a6ee706f8cfbda8f7efbd844415700c74"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Set the filter used by a transliterator. <a href="#aa2523d2f0eb13e3011980cb9d9d0bfa0"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Return the number of system transliterators. <a href="#a9153da8ece577f232fd2a48d4c412577"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Return a UEnumeration for the available transliterators. <a href="#a489c970cc731dac45c3bb5cced4ccb52"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Transliterate a segment of a UReplaceable string. <a href="#a183f6e0cd5b9ef82f3be82c1f6a1b20a"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly. <a href="#ac22b8fe64729a6c99d750020946adad2"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Transliterate a segment of a UChar* string. <a href="#af415d8aa51e79d4494ebb8ef8fc76ae2"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Transliterate the portion of the UChar* text buffer that can be transliterated unambiguosly. <a href="#a9c1e78cfd3e397ea4d8218b4e2572735"></a><br/></td></tr>
<tr><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><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...">utrans_openU()</a> instead. <a href="#afaa9d751e1d24617ba1071d8d4c887a3"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C API: <a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a>. </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 <a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> 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>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a1230b61c2370123b3f17d88dcdc13154"></a><!-- doxytag: member="utrans.h::UTransliterator" ref="a1230b61c2370123b3f17d88dcdc13154" args="" -->
<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 <a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a> and its subclasses. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003913">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="utrans_8h_source.html#l00067">67</a> of file <a class="el" href="utrans_8h_source.html">utrans.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a04f480e9e8e40f0d8067521668dc06ec"></a><!-- doxytag: member="utrans.h::UTransDirection" ref="a04f480e9e8e40f0d8067521668dc06ec" args="" -->
<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#_stable003914">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a04f480e9e8e40f0d8067521668dc06eca112cbaa326ae590fb91ecd99839b6f5f"></a><!-- doxytag: member="UTRANS_FORWARD" ref="a04f480e9e8e40f0d8067521668dc06eca112cbaa326ae590fb91ecd99839b6f5f" args="" -->UTRANS_FORWARD</em> </td><td>
<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 valign="top"><em><a class="anchor" id="a04f480e9e8e40f0d8067521668dc06eca5e10b16d78c21a0df70390998e488c32"></a><!-- doxytag: member="UTRANS_REVERSE" ref="a04f480e9e8e40f0d8067521668dc06eca5e10b16d78c21a0df70390998e488c32" args="" -->UTRANS_REVERSE</em> </td><td>
<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>
</dd>
</dl>
<p>Definition at line <a class="el" href="utrans_8h_source.html#l00077">77</a> of file <a class="el" href="utrans_8h_source.html">utrans.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ac271881fd04dff0dc71bc1d25c807fae"></a><!-- doxytag: member="utrans.h::utrans_clone" ref="ac271881fd04dff0dc71bc1d25c807fae" args="(const UTransliterator *trans, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator to be copied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_stable003918">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a148066969cc61b36a8cbcc76f7dd02f8"></a><!-- doxytag: member="utrans.h::utrans_close" ref="a148066969cc61b36a8cbcc76f7dd02f8" args="(UTransliterator *trans)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator to be closed. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003919">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9153da8ece577f232fd2a48d4c412577"></a><!-- doxytag: member="utrans.h::utrans_countAvailableIDs" ref="a9153da8ece577f232fd2a48d4c412577" args="(void)" -->
<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="return"><dt><b>Returns:</b></dt><dd>the number of system transliterators. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003924">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7ba86b3ce05c45b22b53cdc718266223"></a><!-- doxytag: member="utrans.h::utrans_getAvailableID" ref="a7ba86b3ce05c45b22b53cdc718266223" args="(int32_t index, char *buf, int32_t bufCapacity)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </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 valign="top"></td><td valign="top"><em>buf</em> </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 valign="top"></td><td valign="top"><em>bufCapacity</em> </td><td>the capacity of the buffer. Ignored if buf is NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_deprecated000234">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><!-- doxytag: member="utrans.h::utrans_getID" ref="a5820268446001f80e9cc5fd8c5dc3399" args="(const UTransliterator *trans, char *buf, int32_t bufCapacity)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator to return the ID of. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </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 valign="top"></td><td valign="top"><em>bufCapacity</em> </td><td>the capacity of the buffer. Ignored if buf is NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_deprecated000232">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="a1f2aa5ab7f6dd0fb220602db34975367"></a><!-- doxytag: member="utrans.h::utrans_getUnicodeID" ref="a1f2aa5ab7f6dd0fb220602db34975367" args="(const UTransliterator *trans, int32_t *resultLength)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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...">utrans_openU()</a>, it will open a transliterator equivalent to this one, if the ID has been registered.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator to return the ID of. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>pointer to an output variable receiving the length of the ID string; can be NULL </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_stable003920">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="afaa9d751e1d24617ba1071d8d4c887a3"></a><!-- doxytag: member="utrans.h::utrans_open" ref="afaa9d751e1d24617ba1071d8d4c887a3" args="(const char *id, UTransDirection dir, const UChar *rules, int32_t rulesLength, UParseError *parseError, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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...">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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </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 valign="top"></td><td valign="top"><em>dir</em> </td><td>the desired direction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rules</em> </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 valign="top"></td><td valign="top"><em>rulesLength</em> </td><td>the length of the rules, or -1 if the rules are zero-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseError</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_deprecated000231">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...">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><!-- doxytag: member="utrans.h::utrans_openIDs" ref="a489c970cc731dac45c3bb5cced4ccb52" args="(UErrorCode *pErrorCode)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Pointer to the UErrorCode in/out parameter. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_stable003925">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a9dbdef3ebe320c3e4da826af27ca8bf5"></a><!-- doxytag: member="utrans.h::utrans_openInverse" ref="a9dbdef3ebe320c3e4da826af27ca8bf5" args="(const UTransliterator *trans, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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 <a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a> "A-B" is opened, and then its inverse is opened, the result is the <a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a> "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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator to open the inverse of. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_stable003917">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a014170af31c08e811a61c6b4109b20c9"></a><!-- doxytag: member="utrans.h::utrans_openU" ref="a014170af31c08e811a61c6b4109b20c9" args="(const UChar *id, int32_t idLength, UTransDirection dir, const UChar *rules, int32_t rulesLength, UParseError *parseError, UErrorCode *pErrorCode)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>a valid transliterator ID </td></tr>
<tr><td valign="top"></td><td valign="top"><em>idLength</em> </td><td>the length of the ID string, or -1 if NUL-terminated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dir</em> </td><td>the desired direction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rules</em> </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 valign="top"></td><td valign="top"><em>rulesLength</em> </td><td>the length of the rules, or -1 if the rules are NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseError</em> </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 valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></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#_stable003916">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a1d456df4a9bffef39f2a209283b30c4d"></a><!-- doxytag: member="utrans.h::utrans_register" ref="a1d456df4a9bffef39f2a209283b30c4d" args="(UTransliterator *adoptedTrans, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>adoptedTrans</em> </td><td>a transliterator, typically the result of utrans_openRules(), to be registered with the system. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003921">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa2523d2f0eb13e3011980cb9d9d0bfa0"></a><!-- doxytag: member="utrans.h::utrans_setFilter" ref="aa2523d2f0eb13e3011980cb9d9d0bfa0" args="(UTransliterator *trans, const UChar *filterPattern, int32_t filterPatternLen, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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 <a class="el" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a> pattern. If the filterPattern is NULL or the empty string, then the transliterator will be reset to use no filter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filterPattern</em> </td><td>a pattern string, in the form accepted by <a class="el" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>, specifying which characters to apply the transliteration to. May be NULL or the empty string to indicate no filter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filterPatternLen</em> </td><td>the length of filterPattern, or -1 if filterPattern is zero-terminated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003923">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a183f6e0cd5b9ef82f3be82c1f6a1b20a"></a><!-- doxytag: member="utrans.h::utrans_trans" ref="a183f6e0cd5b9ef82f3be82c1f6a1b20a" args="(const UTransliterator *trans, UReplaceable *rep, UReplaceableCallbacks *repFunc, int32_t start, int32_t *limit, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rep</em> </td><td>a pointer to the string. This will be passed to the repFunc functions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repFunc</em> </td><td>a set of function pointers that will be used to modify the string pointed to by rep. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the beginning index, inclusive; <code>0 <= start <= limit</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>limit</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003926">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac22b8fe64729a6c99d750020946adad2"></a><!-- doxytag: member="utrans.h::utrans_transIncremental" ref="ac22b8fe64729a6c99d750020946adad2" args="(const UTransliterator *trans, UReplaceable *rep, UReplaceableCallbacks *repFunc, UTransPosition *pos, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rep</em> </td><td>a pointer to the string. This will be passed to the repFunc functions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repFunc</em> </td><td>a set of function pointers that will be used to modify the string pointed to by rep. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003927">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9c1e78cfd3e397ea4d8218b4e2572735"></a><!-- doxytag: member="utrans.h::utrans_transIncrementalUChars" ref="a9c1e78cfd3e397ea4d8218b4e2572735" args="(const UTransliterator *trans, UChar *text, int32_t *textLength, int32_t textCapacity, UTransPosition *pos, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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...">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...">utrans_transIncremental()</a> for usage details.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </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 valign="top"></td><td valign="top"><em>textLength</em> </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 valign="top"></td><td valign="top"><em>textCapacity</em> </td><td>the length of the text buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="utrans_8h.html#ac22b8fe64729a6c99d750020946adad2" title="Transliterate the portion of the UReplaceable text buffer that can be transliterated...">utrans_transIncremental</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003929">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af415d8aa51e79d4494ebb8ef8fc76ae2"></a><!-- doxytag: member="utrans.h::utrans_transUChars" ref="af415d8aa51e79d4494ebb8ef8fc76ae2" args="(const UTransliterator *trans, UChar *text, int32_t *textLength, int32_t textCapacity, int32_t start, int32_t *limit, UErrorCode *status)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transliterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </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 valign="top"></td><td valign="top"><em>textLength</em> </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 valign="top"></td><td valign="top"><em>textCapacity</em> </td><td>a pointer to the length of the text buffer. Upon return, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the beginning index, inclusive; <code>0 <= start <= limit</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>limit</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>a pointer to the UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003928">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a71b5c2733100e28705a87aa68a99e469"></a><!-- doxytag: member="utrans.h::utrans_unregister" ref="a71b5c2733100e28705a87aa68a99e469" args="(const char *id)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>a zero-terminated ID </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000233">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><!-- doxytag: member="utrans.h::utrans_unregisterID" ref="a6ee706f8cfbda8f7efbd844415700c74" args="(const UChar *id, int32_t idLength)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>an ID to unregister </td></tr>
<tr><td valign="top"></td><td valign="top"><em>idLength</em> </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#_stable003922">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
799
