<!-- 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.1: ucnvsel.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.2-20100208 --> <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>ucnvsel.h File Reference</h1> <p>A converter selector is built with a set of encoding/charset names and given an input string returns the set of names of the corresponding converters which can convert the string. <a href="#_details">More...</a></p> <code>#include "<a class="el" href="uset_8h_source.html">unicode/uset.h</a>"</code><br/> <code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/> <code>#include "<a class="el" href="utf16_8h_source.html">unicode/utf16.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="ucnv_8h_source.html">unicode/ucnv.h</a>"</code><br/> <code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/> <p><a href="ucnvsel_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>Typedefs</h2></td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p> </div></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4bc48420c52373dc8016be5391bcc723"></a><!-- doxytag: member="ucnvsel.h::UConverterSelector" ref="a4bc48420c52373dc8016be5391bcc723" args="" --> typedef struct UConverterSelector </td><td class="memItemRight" valign="bottom"><b>UConverterSelector</b></td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">UConverterSelector * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnvsel_8h.html#a0b2460b9690ded5c739a77d25b68383b">ucnvsel_open</a> (const char *const *converterList, int32_t converterListSize, const <a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *excludedCodePoints, const <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> whichSet, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open a selector. <a href="#a0b2460b9690ded5c739a77d25b68383b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnvsel_8h.html#a2866ab1e5b479153d8c9ea4d0b2eee1a">ucnvsel_close</a> (UConverterSelector *sel)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Closes a selector. <a href="#a2866ab1e5b479153d8c9ea4d0b2eee1a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">UConverterSelector * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnvsel_8h.html#ae7dd7980455be33af8a36c8559915b78">ucnvsel_openFromSerialized</a> (const void *buffer, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open a selector from its serialized form. <a href="#ae7dd7980455be33af8a36c8559915b78"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucnvsel_8h.html#a9b173a92d3e5206f3fc965523483ddc5">ucnvsel_serialize</a> (const UConverterSelector *sel, void *buffer, int32_t bufferCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Serialize a selector into a linear buffer. <a href="#a9b173a92d3e5206f3fc965523483ddc5"></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="ucnvsel_8h.html#ab3e9d09c18b3c0955fa9c1117cec24c6">ucnvsel_selectForString</a> (const UConverterSelector *sel, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *s, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Select converters that can map all characters in a UTF-16 string, ignoring the excluded code points. <a href="#ab3e9d09c18b3c0955fa9c1117cec24c6"></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="ucnvsel_8h.html#a8542180e560702a880255314d226c30d">ucnvsel_selectForUTF8</a> (const UConverterSelector *sel, const char *s, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Select converters that can map all characters in a UTF-8 string, ignoring the excluded code points. <a href="#a8542180e560702a880255314d226c30d"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A converter selector is built with a set of encoding/charset names and given an input string returns the set of names of the corresponding converters which can convert the string. </p> <p>A converter selector can be serialized into a buffer and reopened from the serialized form. </p> <p>Definition in file <a class="el" href="ucnvsel_8h_source.html">ucnvsel.h</a>.</p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="a2866ab1e5b479153d8c9ea4d0b2eee1a"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_close" ref="a2866ab1e5b479153d8c9ea4d0b2eee1a" args="(UConverterSelector *sel)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ucnvsel_close </td> <td>(</td> <td class="paramtype">UConverterSelector * </td> <td class="paramname"> <em>sel</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Closes a selector. </p> <p>If any Enumerations were returned by ucnv_select*, they become invalid. They can be closed before or after calling ucnv_closeSelector, but should never be used after the selector is closed.</p> <dl class="see"><dt><b>See also:</b></dt><dd>ucnv_selectForString </dd> <dd> ucnv_selectForUTF8</dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>sel</em> </td><td>selector to close</td></tr> </table> </dd> </dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001141">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl> </div> </div> <a class="anchor" id="a0b2460b9690ded5c739a77d25b68383b"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_open" ref="a0b2460b9690ded5c739a77d25b68383b" args="(const char *const *converterList, int32_t converterListSize, const USet *excludedCodePoints, const UConverterUnicodeSet whichSet, UErrorCode *status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">UConverterSelector* ucnvsel_open </td> <td>(</td> <td class="paramtype">const char *const * </td> <td class="paramname"> <em>converterList</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>converterListSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td> <td class="paramname"> <em>excludedCodePoints</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="ucnv_8h.html#a402221896b6d7153b14a5ff8dadde806">UConverterUnicodeSet</a> </td> <td class="paramname"> <em>whichSet</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td> <td class="paramname"> <em>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 a selector. </p> <p>If converterListSize is 0, build for all available converters. If excludedCodePoints is NULL, don't exclude any code points.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>converterList</em> </td><td>a pointer to encoding names needed to be involved. Can be NULL if converterListSize==0. The list and the names will be cloned, and the caller retains ownership of the original. </td></tr> <tr><td valign="top"></td><td valign="top"><em>converterListSize</em> </td><td>number of encodings in above list. If 0, builds a selector for all available converters. </td></tr> <tr><td valign="top"></td><td valign="top"><em>excludedCodePoints</em> </td><td>a set of code points to be excluded from consideration. That is, excluded code points in a string do not change the selection result. (They might be handled by a callback.) Use NULL to exclude nothing. </td></tr> <tr><td valign="top"></td><td valign="top"><em>whichSet</em> </td><td>what converter set to use? Use this to determine whether to consider only roundtrip mappings or also fallbacks. </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>an in/out ICU UErrorCode </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the new selector</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001140">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl> </div> </div> <a class="anchor" id="ae7dd7980455be33af8a36c8559915b78"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_openFromSerialized" ref="ae7dd7980455be33af8a36c8559915b78" args="(const void *buffer, int32_t length, UErrorCode *status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">UConverterSelector* ucnvsel_openFromSerialized </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"> <em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td> <td class="paramname"> <em>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 a selector from its serialized form. </p> <p>The buffer must remain valid and unchanged for the lifetime of the selector. This is much faster than creating a selector from scratch. Using a serialized form from a different machine (endianness/charset) is supported.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>pointer to the serialized form of a converter selector; must be 32-bit-aligned </td></tr> <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the capacity of this buffer (can be equal to or larger than the actual data length) </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>an in/out ICU UErrorCode </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the new selector</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001142">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl> </div> </div> <a class="anchor" id="ab3e9d09c18b3c0955fa9c1117cec24c6"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_selectForString" ref="ab3e9d09c18b3c0955fa9c1117cec24c6" args="(const UConverterSelector *sel, const UChar *s, int32_t length, UErrorCode *status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucnvsel_selectForString </td> <td>(</td> <td class="paramtype">const UConverterSelector * </td> <td class="paramname"> <em>sel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td> <td class="paramname"> <em>status</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Select converters that can map all characters in a UTF-16 string, ignoring the excluded code points. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>sel</em> </td><td>a selector </td></tr> <tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>UTF-16 string </td></tr> <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>length of the string, or -1 if NUL-terminated </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>an in/out ICU UErrorCode </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>an enumeration containing encoding names. The returned encoding names and their order will be the same as supplied when building the selector.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001144">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl> </div> </div> <a class="anchor" id="a8542180e560702a880255314d226c30d"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_selectForUTF8" ref="a8542180e560702a880255314d226c30d" args="(const UConverterSelector *sel, const char *s, int32_t length, UErrorCode *status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucnvsel_selectForUTF8 </td> <td>(</td> <td class="paramtype">const UConverterSelector * </td> <td class="paramname"> <em>sel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td> <td class="paramname"> <em>status</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Select converters that can map all characters in a UTF-8 string, ignoring the excluded code points. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>sel</em> </td><td>a selector </td></tr> <tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>UTF-8 string </td></tr> <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>length of the string, or -1 if NUL-terminated </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>an in/out ICU UErrorCode </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>an enumeration containing encoding names. The returned encoding names and their order will be the same as supplied when building the selector.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001145">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl> </div> </div> <a class="anchor" id="a9b173a92d3e5206f3fc965523483ddc5"></a><!-- doxytag: member="ucnvsel.h::ucnvsel_serialize" ref="a9b173a92d3e5206f3fc965523483ddc5" args="(const UConverterSelector *sel, void *buffer, int32_t bufferCapacity, UErrorCode *status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int32_t ucnvsel_serialize </td> <td>(</td> <td class="paramtype">const UConverterSelector * </td> <td class="paramname"> <em>sel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"> <em>buffer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>bufferCapacity</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>Serialize a selector into a linear buffer. </p> <p>The serialized form is portable to different machines.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>sel</em> </td><td>selector to consider </td></tr> <tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>pointer to 32-bit-aligned memory to be filled with the serialized form of this converter selector </td></tr> <tr><td valign="top"></td><td valign="top"><em>bufferCapacity</em> </td><td>the capacity of this buffer </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>an in/out ICU UErrorCode </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the required buffer capacity to hold serialize data (even if the call fails with a U_BUFFER_OVERFLOW_ERROR, it will return the required capacity)</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001143">Stable:</a></b></dt><dd>ICU 4.2 </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 class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>