<!-- 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: ucasemap.h Source File</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> <h1>ucasemap.h</h1><a href="ucasemap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment">*******************************************************************************</span> <a name="l00003"></a>00003 <span class="comment">*</span> <a name="l00004"></a>00004 <span class="comment">* Copyright (C) 2005-2010, International Business Machines</span> <a name="l00005"></a>00005 <span class="comment">* Corporation and others. All Rights Reserved.</span> <a name="l00006"></a>00006 <span class="comment">*</span> <a name="l00007"></a>00007 <span class="comment">*******************************************************************************</span> <a name="l00008"></a>00008 <span class="comment">* file name: ucasemap.h</span> <a name="l00009"></a>00009 <span class="comment">* encoding: US-ASCII</span> <a name="l00010"></a>00010 <span class="comment">* tab size: 8 (not used)</span> <a name="l00011"></a>00011 <span class="comment">* indentation:4</span> <a name="l00012"></a>00012 <span class="comment">*</span> <a name="l00013"></a>00013 <span class="comment">* created on: 2005may06</span> <a name="l00014"></a>00014 <span class="comment">* created by: Markus W. Scherer</span> <a name="l00015"></a>00015 <span class="comment">*</span> <a name="l00016"></a>00016 <span class="comment">* Case mapping service object and functions using it.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef __UCASEMAP_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __UCASEMAP_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span> <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="ustring_8h.html" title="C API: Unicode string handling functions.">unicode/ustring.h</a>"</span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="localpointer_8h.html" title="C++ API: &quot;Smart pointers&quot; for use with and in ICU4C C++ code.">unicode/localpointer.h</a>"</span> <a name="l00025"></a>00025 <a name="l00044"></a>00044 <span class="keyword">struct </span><a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a>; <a name="l00045"></a><a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca">00045</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a>; <a name="l00069"></a>00069 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00070"></a>00070 <a class="code" href="ucasemap_8h.html#a40df152b19d07dba4cc9d5b3015b27d1" title="Open a UCaseMap service object for a locale and a set of options.">ucasemap_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *locale, uint32_t options, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00071"></a>00071 <a name="l00077"></a>00077 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00078"></a>00078 <a class="code" href="ucasemap_8h.html#acf25fdcf78936f8e0567a68962c0ddf8" title="Close a UCaseMap service object.">ucasemap_close</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm); <a name="l00079"></a>00079 <a name="l00080"></a>00080 <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span> <a name="l00081"></a>00081 <span class="preprocessor"></span> <a name="l00082"></a>00082 <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a> <a name="l00083"></a>00083 <a name="l00093"></a>00093 U_DEFINE_LOCAL_OPEN_POINTER(LocalUCaseMapPointer, <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a>, <a class="code" href="ucasemap_8h.html#acf25fdcf78936f8e0567a68962c0ddf8" title="Close a UCaseMap service object.">ucasemap_close</a>); <a name="l00094"></a>00094 <a name="l00095"></a>00095 <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a> <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="preprocessor">#endif</span> <a name="l00098"></a>00098 <span class="preprocessor"></span> <a name="l00105"></a>00105 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00106"></a>00106 <a class="code" href="ucasemap_8h.html#a3a7a9d9d7dbe7f723d666a9dc1556c6b" title="Get the locale ID that is used for language-dependent case mappings.">ucasemap_getLocale</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm); <a name="l00107"></a>00107 <a name="l00114"></a>00114 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> uint32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00115"></a>00115 <a class="code" href="ucasemap_8h.html#a811753309b4eb249429c7a7f86accae1" title="Get the options bit set that is used for case folding and string comparisons.">ucasemap_getOptions</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm); <a name="l00116"></a>00116 <a name="l00128"></a>00128 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00129"></a>00129 <a class="code" href="ucasemap_8h.html#a907584719eb4fb3678fcb885c5f06059" title="Set the locale ID that is used for language-dependent case mappings.">ucasemap_setLocale</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <span class="keyword">const</span> <span class="keywordtype">char</span> *locale, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00130"></a>00130 <a name="l00142"></a>00142 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00143"></a>00143 <a class="code" href="ucasemap_8h.html#a06ddc797846dfd55bc4bd81ff30a5e56" title="Set the options bit set that is used for case folding and string comparisons.">ucasemap_setOptions</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, uint32_t options, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00144"></a>00144 <a name="l00159"></a><a class="code" href="ucasemap_8h.html#aab9de6ad843adcbc21001f7f93f1e888">00159</a> <span class="preprocessor">#define U_TITLECASE_NO_LOWERCASE 0x100</span> <a name="l00160"></a>00160 <span class="preprocessor"></span> <a name="l00184"></a><a class="code" href="ucasemap_8h.html#afc65fa226cac9b8eeef0e877b8a7744e">00184</a> <span class="preprocessor">#define U_TITLECASE_NO_BREAK_ADJUSTMENT 0x200</span> <a name="l00185"></a>00185 <span class="preprocessor"></span> <a name="l00186"></a>00186 <span class="preprocessor">#if !UCONFIG_NO_BREAK_ITERATION</span> <a name="l00187"></a>00187 <span class="preprocessor"></span> <a name="l00195"></a>00195 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keyword">const</span> <a class="code" href="ubrk_8h.html#adb85bb46d5f93c87098e11deab50bef4" title="A text-break iterator.">UBreakIterator</a> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00196"></a>00196 <a class="code" href="ucasemap_8h.html#a2d3ecd2ab71395582ac92e263e0b50e0" title="Get the break iterator that is used for titlecasing.">ucasemap_getBreakIterator</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm); <a name="l00197"></a>00197 <a name="l00218"></a>00218 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00219"></a>00219 <a class="code" href="ucasemap_8h.html#a1928a194cb0d8b6ca3617d61f534cbc5" title="Set the break iterator that is used for titlecasing.">ucasemap_setBreakIterator</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a class="code" href="ubrk_8h.html#adb85bb46d5f93c87098e11deab50bef4" title="A text-break iterator.">UBreakIterator</a> *iterToAdopt, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00220"></a>00220 <a name="l00267"></a>00267 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00268"></a>00268 <a class="code" href="ucasemap_8h.html#ab8002df7573b0dbf6e0a19ff3cc09b5d" title="Titlecase a UTF-16 string.">ucasemap_toTitle</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a name="l00269"></a>00269 <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned...">UChar</a> *dest, int32_t destCapacity, <a name="l00270"></a>00270 <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned...">UChar</a> *src, int32_t srcLength, <a name="l00271"></a>00271 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00272"></a>00272 <a name="l00273"></a>00273 <span class="preprocessor">#endif</span> <a name="l00274"></a>00274 <span class="preprocessor"></span> <a name="l00298"></a>00298 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00299"></a>00299 <a class="code" href="ucasemap_8h.html#a8d14045335e130a16b68213194a04cc0" title="Lowercase the characters in a UTF-8 string.">ucasemap_utf8ToLower</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a name="l00300"></a>00300 <span class="keywordtype">char</span> *dest, int32_t destCapacity, <a name="l00301"></a>00301 <span class="keyword">const</span> <span class="keywordtype">char</span> *src, int32_t srcLength, <a name="l00302"></a>00302 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00303"></a>00303 <a name="l00327"></a>00327 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00328"></a>00328 <a class="code" href="ucasemap_8h.html#a817d31c95e792462407a119b5fdbedc7" title="Uppercase the characters in a UTF-8 string.">ucasemap_utf8ToUpper</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a name="l00329"></a>00329 <span class="keywordtype">char</span> *dest, int32_t destCapacity, <a name="l00330"></a>00330 <span class="keyword">const</span> <span class="keywordtype">char</span> *src, int32_t srcLength, <a name="l00331"></a>00331 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00332"></a>00332 <a name="l00333"></a>00333 <span class="preprocessor">#if !UCONFIG_NO_BREAK_ITERATION</span> <a name="l00334"></a>00334 <span class="preprocessor"></span> <a name="l00379"></a>00379 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00380"></a>00380 <a class="code" href="ucasemap_8h.html#a4ef18fcd15be677e4b17bf70fda02551" title="Titlecase a UTF-8 string.">ucasemap_utf8ToTitle</a>(<a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a name="l00381"></a>00381 <span class="keywordtype">char</span> *dest, int32_t destCapacity, <a name="l00382"></a>00382 <span class="keyword">const</span> <span class="keywordtype">char</span> *src, int32_t srcLength, <a name="l00383"></a>00383 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00384"></a>00384 <a name="l00385"></a>00385 <span class="preprocessor">#endif</span> <a name="l00386"></a>00386 <span class="preprocessor"></span> <a name="l00415"></a>00415 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00416"></a>00416 <a class="code" href="ucasemap_8h.html#a7a3a403ca36e0ff7a4e5ecf821f2583c" title="Case-fold the characters in a UTF-8 string.">ucasemap_utf8FoldCase</a>(<span class="keyword">const</span> <a class="code" href="ucasemap_8h.html#a2c127e061c4bc5f4ccc9defbe01f9dca" title="C typedef for struct UCaseMap.">UCaseMap</a> *csm, <a name="l00417"></a>00417 <span class="keywordtype">char</span> *dest, int32_t destCapacity, <a name="l00418"></a>00418 <span class="keyword">const</span> <span class="keywordtype">char</span> *src, int32_t srcLength, <a name="l00419"></a>00419 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *pErrorCode); <a name="l00420"></a>00420 <a name="l00421"></a>00421 <span class="preprocessor">#endif</span> </pre></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>