<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: ucasemap.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</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 File Reference</h1>C API: Unicode case mapping functions using a UCaseMap service object. <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="ustring_8h-source.html">unicode/ustring.h</a>"</code><br>
<p>
<a href="ucasemap_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#ab9de6ad843adcbc21001f7f93f1e888">U_TITLECASE_NO_LOWERCASE</a> 0x100</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not lowercase non-initial parts of words when titlecasing. <a href="#ab9de6ad843adcbc21001f7f93f1e888"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#fc65fa226cac9b8eeef0e877b8a7744e">U_TITLECASE_NO_BREAK_ADJUSTMENT</a> 0x200</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not adjust the titlecasing indexes from <a class="el" href="classBreakIterator.html#68f3b6be789195b55204a6d86d58a8ad">BreakIterator::next()</a> indexes; titlecase exactly the characters at breaks from the iterator. <a href="#fc65fa226cac9b8eeef0e877b8a7744e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">C typedef for struct UCaseMap. <a href="#2c127e061c4bc5f4ccc9defbe01f9dca"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#40df152b19d07dba4cc9d5b3015b27d1">ucasemap_open</a> (const char *locale, <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> options, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a UCaseMap service object for a locale and a set of options. <a href="#40df152b19d07dba4cc9d5b3015b27d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#cf25fdcf78936f8e0567a68962c0ddf8">ucasemap_close</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a UCaseMap service object. <a href="#cf25fdcf78936f8e0567a68962c0ddf8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#3a7a9d9d7dbe7f723d666a9dc1556c6b">ucasemap_getLocale</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the locale ID that is used for language-dependent case mappings. <a href="#3a7a9d9d7dbe7f723d666a9dc1556c6b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#811753309b4eb249429c7a7f86accae1">ucasemap_getOptions</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the options bit set that is used for case folding and string comparisons. <a href="#811753309b4eb249429c7a7f86accae1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#907584719eb4fb3678fcb885c5f06059">ucasemap_setLocale</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, const char *locale, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the locale ID that is used for language-dependent case mappings. <a href="#907584719eb4fb3678fcb885c5f06059"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> options, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the options bit set that is used for case folding and string comparisons. <a href="#06ddc797846dfd55bc4bd81ff30a5e56"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="ustring_8h.html#91403765077ce0615043a82d9adef758">UBreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#2d3ecd2ab71395582ac92e263e0b50e0">ucasemap_getBreakIterator</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the break iterator that is used for titlecasing. <a href="#2d3ecd2ab71395582ac92e263e0b50e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#1928a194cb0d8b6ca3617d61f534cbc5">ucasemap_setBreakIterator</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, <a class="el" href="ustring_8h.html#91403765077ce0615043a82d9adef758">UBreakIterator</a> *iterToAdopt, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the break iterator that is used for titlecasing. <a href="#1928a194cb0d8b6ca3617d61f534cbc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#b8002df7573b0dbf6e0a19ff3cc09b5d">ucasemap_toTitle</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, UChar *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, const UChar *src, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> srcLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Titlecase a UTF-16 string. <a href="#b8002df7573b0dbf6e0a19ff3cc09b5d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#8d14045335e130a16b68213194a04cc0">ucasemap_utf8ToLower</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, char *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, const char *src, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> srcLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lowercase the characters in a UTF-8 string. <a href="#8d14045335e130a16b68213194a04cc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#817d31c95e792462407a119b5fdbedc7">ucasemap_utf8ToUpper</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, char *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, const char *src, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> srcLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uppercase the characters in a UTF-8 string. <a href="#817d31c95e792462407a119b5fdbedc7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#4ef18fcd15be677e4b17bf70fda02551">ucasemap_utf8ToTitle</a> (<a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, char *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, const char *src, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> srcLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Titlecase a UTF-8 string. <a href="#4ef18fcd15be677e4b17bf70fda02551"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucasemap_8h.html#7a3a403ca36e0ff7a4e5ecf821f2583c">ucasemap_utf8FoldCase</a> (const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> *csm, char *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, const char *src, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> srcLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *<a class="el" href="ucnv_8h.html#dbf2cd1916edd4b0144730376dc993f3">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Case-fold the characters in a UTF-8 string. <a href="#7a3a403ca36e0ff7a4e5ecf821f2583c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C API: Unicode case mapping functions using a UCaseMap service object.
<p>
The service object takes care of memory allocations, data loading, and setup for the attributes, as usual.<p>
Currently, the functionality provided here does not overlap with <a class="el" href="uchar_8h.html">uchar.h</a> and <a class="el" href="ustring_8h.html">ustring.h</a>, except for <a class="el" href="ucasemap_8h.html#b8002df7573b0dbf6e0a19ff3cc09b5d">ucasemap_toTitle()</a>.<p>
ucasemap_utf8XYZ() functions operate directly on UTF-8 strings.
<p>
Definition in file <a class="el" href="ucasemap_8h-source.html">ucasemap.h</a>.<hr><h2>Define Documentation</h2>
<a class="anchor" name="fc65fa226cac9b8eeef0e877b8a7744e"></a><!-- doxytag: member="ucasemap.h::U_TITLECASE_NO_BREAK_ADJUSTMENT" ref="fc65fa226cac9b8eeef0e877b8a7744e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_TITLECASE_NO_BREAK_ADJUSTMENT 0x200 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do not adjust the titlecasing indexes from <a class="el" href="classBreakIterator.html#68f3b6be789195b55204a6d86d58a8ad">BreakIterator::next()</a> indexes; titlecase exactly the characters at breaks from the iterator.
<p>
Option bit for titlecasing APIs that take an options bit set.<p>
By default, titlecasing will take each break iterator index, adjust it by looking for the next cased character, and titlecase that one. Other characters are lowercased.<p>
This follows Unicode 4 & 5 section 3.13 Default Case Operations:<p>
R3 toTitlecase(X): Find the word boundaries based on Unicode Standard Annex #29, "Text Boundaries." Between each pair of word boundaries, find the first cased character F. If F exists, map F to default_title(F); then map each subsequent character C to default_lower(C).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions</a> <p>
<a class="el" href="ucasemap_8h.html#b8002df7573b0dbf6e0a19ff3cc09b5d">ucasemap_toTitle</a> <p>
<a class="el" href="ucasemap_8h.html#4ef18fcd15be677e4b17bf70fda02551">ucasemap_utf8ToTitle</a> <p>
<a class="el" href="classUnicodeString.html#76491929251438d4aa982c8f4c1bebfa">UnicodeString::toTitle</a> <p>
<a class="el" href="ucasemap_8h.html#ab9de6ad843adcbc21001f7f93f1e888">U_TITLECASE_NO_LOWERCASE</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000002">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
<p>
Definition at line <a class="el" href="ucasemap_8h-source.html#l00166">166</a> of file <a class="el" href="ucasemap_8h-source.html">ucasemap.h</a>.
</div>
</div><p>
<a class="anchor" name="ab9de6ad843adcbc21001f7f93f1e888"></a><!-- doxytag: member="ucasemap.h::U_TITLECASE_NO_LOWERCASE" ref="ab9de6ad843adcbc21001f7f93f1e888" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_TITLECASE_NO_LOWERCASE 0x100 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do not lowercase non-initial parts of words when titlecasing.
<p>
Option bit for titlecasing APIs that take an options bit set.<p>
By default, titlecasing will titlecase the first cased character of a word and lowercase all other characters. With this option, the other characters will not be modified.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions</a> <p>
<a class="el" href="ucasemap_8h.html#b8002df7573b0dbf6e0a19ff3cc09b5d">ucasemap_toTitle</a> <p>
<a class="el" href="ucasemap_8h.html#4ef18fcd15be677e4b17bf70fda02551">ucasemap_utf8ToTitle</a> <p>
<a class="el" href="classUnicodeString.html#76491929251438d4aa982c8f4c1bebfa">UnicodeString::toTitle</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000001">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
<p>
Definition at line <a class="el" href="ucasemap_8h-source.html#l00141">141</a> of file <a class="el" href="ucasemap_8h-source.html">ucasemap.h</a>.
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="2c127e061c4bc5f4ccc9defbe01f9dca"></a><!-- doxytag: member="ucasemap.h::UCaseMap" ref="2c127e061c4bc5f4ccc9defbe01f9dca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
C typedef for struct UCaseMap.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000442">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>
Definition at line <a class="el" href="ucasemap_8h-source.html#l00044">44</a> of file <a class="el" href="ucasemap_8h-source.html">ucasemap.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="cf25fdcf78936f8e0567a68962c0ddf8"></a><!-- doxytag: member="ucasemap.h::ucasemap_close" ref="cf25fdcf78936f8e0567a68962c0ddf8" args="(UCaseMap *csm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucasemap_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close a UCaseMap service object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>Object to be closed. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000444">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2d3ecd2ab71395582ac92e263e0b50e0"></a><!-- doxytag: member="ucasemap.h::ucasemap_getBreakIterator" ref="2d3ecd2ab71395582ac92e263e0b50e0" args="(const UCaseMap *csm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ustring_8h.html#91403765077ce0615043a82d9adef758">UBreakIterator</a>* ucasemap_getBreakIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the break iterator that is used for titlecasing.
<p>
Do not modify the returned break iterator. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>titlecasing break iterator </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000003">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3a7a9d9d7dbe7f723d666a9dc1556c6b"></a><!-- doxytag: member="ucasemap.h::ucasemap_getLocale" ref="3a7a9d9d7dbe7f723d666a9dc1556c6b" args="(const UCaseMap *csm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucasemap_getLocale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the locale ID that is used for language-dependent case mappings.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>locale ID </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000445">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="811753309b4eb249429c7a7f86accae1"></a><!-- doxytag: member="ucasemap.h::ucasemap_getOptions" ref="811753309b4eb249429c7a7f86accae1" args="(const UCaseMap *csm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> ucasemap_getOptions </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the options bit set that is used for case folding and string comparisons.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>options bit set </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000446">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="40df152b19d07dba4cc9d5b3015b27d1"></a><!-- doxytag: member="ucasemap.h::ucasemap_open" ref="40df152b19d07dba4cc9d5b3015b27d1" args="(const char *locale, uint32_t options, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a>* ucasemap_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"> <em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open a UCaseMap service object for a locale and a set of options.
<p>
The locale ID and options are preprocessed so that functions using the service object need not process them in each call.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>ICU locale ID, used for language-dependent upper-/lower-/title-casing according to the Unicode standard. Usual semantics: ""=root, NULL=default locale, etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>Options bit set, used for case folding and string comparisons. Same flags as for <a class="el" href="uchar_8h.html#92925c095397f6af772717acec165d01">u_foldCase()</a>, <a class="el" href="ustring_8h.html#b6709b5a5c1606cf0d3ea24934d9acce">u_strFoldCase()</a>, <a class="el" href="ustring_8h.html#56c7ed13d57379ff8b5f0736b0628e09">u_strCaseCompare()</a>, etc. Use 0 or U_FOLD_CASE_DEFAULT for default behavior. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to a UCaseMap service object, if successful.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uchar_8h.html#7c41915be9809fd815a5c7d581ad1ea3">U_FOLD_CASE_DEFAULT</a> <p>
<a class="el" href="uchar_8h.html#2d074cf9ee160fbcaec63740c4f9689e">U_FOLD_CASE_EXCLUDE_SPECIAL_I</a> <p>
<a class="el" href="ucasemap_8h.html#ab9de6ad843adcbc21001f7f93f1e888">U_TITLECASE_NO_LOWERCASE</a> <p>
<a class="el" href="ucasemap_8h.html#fc65fa226cac9b8eeef0e877b8a7744e">U_TITLECASE_NO_BREAK_ADJUSTMENT</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000443">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1928a194cb0d8b6ca3617d61f534cbc5"></a><!-- doxytag: member="ucasemap.h::ucasemap_setBreakIterator" ref="1928a194cb0d8b6ca3617d61f534cbc5" args="(UCaseMap *csm, UBreakIterator *iterToAdopt, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucasemap_setBreakIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ustring_8h.html#91403765077ce0615043a82d9adef758">UBreakIterator</a> * </td>
<td class="paramname"> <em>iterToAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the break iterator that is used for titlecasing.
<p>
The UCaseMap service object releases a previously set break iterator and "adopts" this new one, taking ownership of it. It will be released in a subsequent call to <a class="el" href="ucasemap_8h.html#1928a194cb0d8b6ca3617d61f534cbc5">ucasemap_setBreakIterator()</a> or <a class="el" href="ucasemap_8h.html#cf25fdcf78936f8e0567a68962c0ddf8">ucasemap_close()</a>.<p>
Break iterator operations are not thread-safe. Therefore, titlecasing functions use non-const UCaseMap objects. It is not possible to titlecase strings concurrently using the same UCaseMap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iterToAdopt</em> </td><td>Break iterator to be adopted for titlecasing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucasemap_8h.html#b8002df7573b0dbf6e0a19ff3cc09b5d">ucasemap_toTitle</a> <p>
<a class="el" href="ucasemap_8h.html#4ef18fcd15be677e4b17bf70fda02551">ucasemap_utf8ToTitle</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000004">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="907584719eb4fb3678fcb885c5f06059"></a><!-- doxytag: member="ucasemap.h::ucasemap_setLocale" ref="907584719eb4fb3678fcb885c5f06059" args="(UCaseMap *csm, const char *locale, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucasemap_setLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the locale ID that is used for language-dependent case mappings.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td><a class="el" href="classLocale.html">Locale</a> ID, see <a class="el" href="ucasemap_8h.html#40df152b19d07dba4cc9d5b3015b27d1">ucasemap_open()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucasemap_8h.html#40df152b19d07dba4cc9d5b3015b27d1">ucasemap_open</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000447">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="06ddc797846dfd55bc4bd81ff30a5e56"></a><!-- doxytag: member="ucasemap.h::ucasemap_setOptions" ref="06ddc797846dfd55bc4bd81ff30a5e56" args="(UCaseMap *csm, uint32_t options, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucasemap_setOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"> <em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the options bit set that is used for case folding and string comparisons.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>Options bit set, see <a class="el" href="ucasemap_8h.html#40df152b19d07dba4cc9d5b3015b27d1">ucasemap_open()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucasemap_8h.html#40df152b19d07dba4cc9d5b3015b27d1">ucasemap_open</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000448">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b8002df7573b0dbf6e0a19ff3cc09b5d"></a><!-- doxytag: member="ucasemap.h::ucasemap_toTitle" ref="b8002df7573b0dbf6e0a19ff3cc09b5d" args="(UCaseMap *csm, UChar *dest, int32_t destCapacity, const UChar *src, int32_t srcLength, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ucasemap_toTitle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Titlecase a UTF-16 string.
<p>
This function is almost a duplicate of <a class="el" href="ustring_8h.html#8c6202ad4ac954e225aae061b184e450">u_strToTitle()</a>, except that it takes <a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions()</a> into account and has performance advantages from being able to use a UCaseMap object for multiple case mapping operations, saving setup time.<p>
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with <a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions()</a>.)<p>
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.<p>
This function uses only the setText(), first() and next() methods of the provided break iterator.<p>
The result may be longer or shorter than the original. The source string and the destination buffer must not overlap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>A buffer for the result string. The result will be NUL-terminated if the buffer is large enough. The contents is undefined in case of failure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the buffer (number of bytes). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The original string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcLength</em> </td><td>The length of the original string. If -1, then src must be NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string, if successful - or in case of a buffer overflow, in which case it will be greater than destCapacity.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ustring_8h.html#8c6202ad4ac954e225aae061b184e450">u_strToTitle</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000005">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7a3a403ca36e0ff7a4e5ecf821f2583c"></a><!-- doxytag: member="ucasemap.h::ucasemap_utf8FoldCase" ref="7a3a403ca36e0ff7a4e5ecf821f2583c" args="(const UCaseMap *csm, char *dest, int32_t destCapacity, const char *src, int32_t srcLength, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ucasemap_utf8FoldCase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Case-fold the characters in a UTF-8 string.
<p>
Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'I' in CaseFolding.txt. The result may be longer or shorter than the original. The source string and the destination buffer must not overlap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>A buffer for the result string. The result will be NUL-terminated if the buffer is large enough. The contents is undefined in case of failure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the buffer (number of bytes). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The original string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcLength</em> </td><td>The length of the original string. If -1, then src must be NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string, if successful - or in case of a buffer overflow, in which case it will be greater than destCapacity.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ustring_8h.html#b6709b5a5c1606cf0d3ea24934d9acce">u_strFoldCase</a> <p>
<a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions</a> <p>
<a class="el" href="uchar_8h.html#7c41915be9809fd815a5c7d581ad1ea3">U_FOLD_CASE_DEFAULT</a> <p>
<a class="el" href="uchar_8h.html#2d074cf9ee160fbcaec63740c4f9689e">U_FOLD_CASE_EXCLUDE_SPECIAL_I</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000007">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8d14045335e130a16b68213194a04cc0"></a><!-- doxytag: member="ucasemap.h::ucasemap_utf8ToLower" ref="8d14045335e130a16b68213194a04cc0" args="(const UCaseMap *csm, char *dest, int32_t destCapacity, const char *src, int32_t srcLength, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ucasemap_utf8ToLower </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lowercase the characters in a UTF-8 string.
<p>
Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original. The source string and the destination buffer must not overlap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>A buffer for the result string. The result will be NUL-terminated if the buffer is large enough. The contents is undefined in case of failure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the buffer (number of bytes). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The original string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcLength</em> </td><td>The length of the original string. If -1, then src must be NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string, if successful - or in case of a buffer overflow, in which case it will be greater than destCapacity.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ustring_8h.html#e3ed589f5ce0d550c228ee69bfed58fb">u_strToLower</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000449">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4ef18fcd15be677e4b17bf70fda02551"></a><!-- doxytag: member="ucasemap.h::ucasemap_utf8ToTitle" ref="4ef18fcd15be677e4b17bf70fda02551" args="(UCaseMap *csm, char *dest, int32_t destCapacity, const char *src, int32_t srcLength, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ucasemap_utf8ToTitle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Titlecase a UTF-8 string.
<p>
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with <a class="el" href="ucasemap_8h.html#06ddc797846dfd55bc4bd81ff30a5e56">ucasemap_setOptions()</a>.)<p>
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.<p>
This function uses only the setText(), first() and next() methods of the provided break iterator.<p>
The result may be longer or shorter than the original. The source string and the destination buffer must not overlap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>A buffer for the result string. The result will be NUL-terminated if the buffer is large enough. The contents is undefined in case of failure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the buffer (number of bytes). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The original string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcLength</em> </td><td>The length of the original string. If -1, then src must be NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string, if successful - or in case of a buffer overflow, in which case it will be greater than destCapacity.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ustring_8h.html#8c6202ad4ac954e225aae061b184e450">u_strToTitle</a> <p>
<a class="el" href="ucasemap_8h.html#ab9de6ad843adcbc21001f7f93f1e888">U_TITLECASE_NO_LOWERCASE</a> <p>
<a class="el" href="ucasemap_8h.html#fc65fa226cac9b8eeef0e877b8a7744e">U_TITLECASE_NO_BREAK_ADJUSTMENT</a> </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000006">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="817d31c95e792462407a119b5fdbedc7"></a><!-- doxytag: member="ucasemap.h::ucasemap_utf8ToUpper" ref="817d31c95e792462407a119b5fdbedc7" args="(const UCaseMap *csm, char *dest, int32_t destCapacity, const char *src, int32_t srcLength, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ucasemap_utf8ToUpper </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucasemap_8h.html#2c127e061c4bc5f4ccc9defbe01f9dca">UCaseMap</a> * </td>
<td class="paramname"> <em>csm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>srcLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uppercase the characters in a UTF-8 string.
<p>
Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original. The source string and the destination buffer must not overlap.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>csm</em> </td><td>UCaseMap service object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>A buffer for the result string. The result will be NUL-terminated if the buffer is large enough. The contents is undefined in case of failure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the buffer (number of bytes). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The original string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcLength</em> </td><td>The length of the original string. If -1, then src must be NUL-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string, if successful - or in case of a buffer overflow, in which case it will be greater than destCapacity.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ustring_8h.html#14740e3b734ffa82205d4762fcacb5e1">u_strToUpper</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000450">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:24 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
