<!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.6: ubrk.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.4.7 -->
<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>ubrk.h File Reference</h1>C API: <a class="el" href="classBreakIterator.html">BreakIterator</a>. <a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="utypes_8h-source.html">unicode/utypes.h</a>"</code><br>
<code>#include "<a class="el" href="uloc_8h-source.html">unicode/uloc.h</a>"</code><br>
<code>#include "<a class="el" href="utext_8h-source.html">unicode/utext.h</a>"</code><br>
<code>#include "<a class="el" href="parseerr_8h-source.html">unicode/parseerr.h</a>"</code><br>
<p>
<a href="ubrk_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="ubrk_8h.html#2c3879dff3464e017ea369aaae683663">UBRK_DONE</a> ((<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a>) -1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Value indicating all text boundaries have been returned. <a href="#2c3879dff3464e017ea369aaae683663"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#51437894cf1d6a00dc9eae70a5ecb638">U_BRK_SAFECLONE_BUFFERSIZE</a> 512</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A recommended size (in bytes) for the memory buffer to be passed to ubrk_saveClone(). <a href="#51437894cf1d6a00dc9eae70a5ecb638"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque type representing an ICU Break iterator object. <a href="#b3f067cc3bed4e510e064dfc30e1cb73"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">UBreakIteratorType</a> { <br>
<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1ab489e4d6f3c7d30cee4c465aace8ae6">UBRK_CHARACTER</a> = 0,
<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f19d6d07a19177eb1b5ba9e704685ae4c0">UBRK_WORD</a> = 1,
<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f17b987f9693192e181a10240249e8c3bd">UBRK_LINE</a> = 2,
<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f184b0a621c9b23cd8669c2ba1b11e031a">UBRK_SENTENCE</a> = 3,
<br>
<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f151071e7772afd935efd328a32798c41b">UBRK_TITLE</a> = 4,
<b>UBRK_COUNT</b> = 5
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The possible types of text boundaries. <a href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195">UWordBreak</a> { <br>
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a19585e3c56a483b3a4a2a69290d4712a28c">UBRK_WORD_NONE</a> = 0,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a19570c6d61484b0918ac9bd9af367a60279">UBRK_WORD_NONE_LIMIT</a> = 100,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195a8d66bc4ed65b6af62f9b88ce7a1c404">UBRK_WORD_NUMBER</a> = 100,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a1956484c83c0ae1cf0af7c070f4d292fb84">UBRK_WORD_NUMBER_LIMIT</a> = 200,
<br>
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195fecfedc16850228215bd228f08fac546">UBRK_WORD_LETTER</a> = 200,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195a435fe232eedc5eabbb9d0fb1b652884">UBRK_WORD_LETTER_LIMIT</a> = 300,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a1959368c16d6ed2820ddf7afa42035042ed">UBRK_WORD_KANA</a> = 300,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a1953b8c1fb477075b27d2f573151e2c044d">UBRK_WORD_KANA_LIMIT</a> = 400,
<br>
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195a5a7abfa6f4f01226af00cde1d94c8f0">UBRK_WORD_IDEO</a> = 400,
<a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195e91225a285d7fc739fa4871f70410fa9">UBRK_WORD_IDEO_LIMIT</a> = 500
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum constants for the word break tags returned by getRuleStatus(). <a href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72">ULineBreakTag</a> { <a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72ab47373013dfb58462dd0930e336f4cf">UBRK_LINE_SOFT</a> = 0,
<a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72376988bdbf7dc51d441cd55ec3f76cd6">UBRK_LINE_SOFT_LIMIT</a> = 100,
<a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72f2f90bf850ab885ef54f7613e617f190">UBRK_LINE_HARD</a> = 100,
<a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b7284c5f535aaf6d718eb041b3385f396ce">UBRK_LINE_HARD_LIMIT</a> = 200
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum constants for the line break tags returned by getRuleStatus(). <a href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f">USentenceBreakTag</a> { <a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f0c70bf2aeba912a2ce639253ed192c13">UBRK_SENTENCE_TERM</a> = 0,
<a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f83a6be2df5c8f1b37f17e15d87979456">UBRK_SENTENCE_TERM_LIMIT</a> = 100,
<a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2fe16c873a9f7af8f805b3f5115f8b73d3">UBRK_SENTENCE_SEP</a> = 100,
<a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f0053103092a1b527bbe8cbc8d931dd48">UBRK_SENTENCE_SEP_LIMIT</a> = 200
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum constants for the sentence break tags returned by getRuleStatus(). <a href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f">More...</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="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#7b60c35a976fe67955124efb68f0ffc0">ubrk_open</a> (<a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">UBreakIteratorType</a> type, const char *locale, const UChar *text, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textLength, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a new UBreakIterator for locating text boundaries for a specified locale. <a href="#7b60c35a976fe67955124efb68f0ffc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#fdb60f731ef47f5287f84b79917e38d7">ubrk_openRules</a> (const UChar *rules, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> rulesLength, const UChar *text, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textLength, <a class="el" href="structUParseError.html">UParseError</a> *parseErr, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a new UBreakIterator for locating text boundaries using specified breaking rules. <a href="#fdb60f731ef47f5287f84b79917e38d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#2c8803c1611d35a02f8b6c563894e848">ubrk_safeClone</a> (const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, void *stackBuffer, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> *pBufferSize, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thread safe cloning operation. <a href="#2c8803c1611d35a02f8b6c563894e848"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#9ed759eb3daf955551988c92a0b9fe8b">ubrk_close</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a UBreakIterator. <a href="#9ed759eb3daf955551988c92a0b9fe8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#dc1a24f65f52180dfe059c3849bcda49">ubrk_setText</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, const UChar *text, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textLength, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an existing iterator to point to a new piece of text. <a href="#dc1a24f65f52180dfe059c3849bcda49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#0aa35691e73c054712950489496e4d21">ubrk_setUText</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="structUText.html">UText</a> *text, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an existing iterator to point to a new piece of text. <a href="#0aa35691e73c054712950489496e4d21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#3d1bba7a735be64dcdbdfb79cca3fea2">ubrk_current</a> (const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the most recently-returned text boundary. <a href="#3d1bba7a735be64dcdbdfb79cca3fea2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#1fcb93e30c407933992974e19cd77c72">ubrk_next</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the text boundary following the current text boundary. <a href="#1fcb93e30c407933992974e19cd77c72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#e7a4cf3d12c2cefcc342c2ee139fba66">ubrk_previous</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the text boundary preceding the current text boundary. <a href="#e7a4cf3d12c2cefcc342c2ee139fba66"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#f955c40c9d58cedc4b5ebd298a3a49b5">ubrk_first</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the index of the first character in the text being scanned. <a href="#f955c40c9d58cedc4b5ebd298a3a49b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#e7b75242e744d14e0fdcc63389653eeb">ubrk_last</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the index immediately <em>beyond</em> the last character in the text being scanned. <a href="#e7b75242e744d14e0fdcc63389653eeb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#66670badda84913bcf36262dc407bc16">ubrk_preceding</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the text boundary preceding the specified offset. <a href="#66670badda84913bcf36262dc407bc16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#43ecb05af93098de19e3f48b614e88e3">ubrk_following</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the text boundary following the specified offset. <a href="#43ecb05af93098de19e3f48b614e88e3"></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="ubrk_8h.html#550e2f0c6b28ba39c8d42debfa85e8a3">ubrk_getAvailable</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a locale for which text breaking information is available. <a href="#550e2f0c6b28ba39c8d42debfa85e8a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#894ec55bae57e25af280e6493a3e30d2">ubrk_countAvailable</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine how many locales have text breaking information available. <a href="#894ec55bae57e25af280e6493a3e30d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#132e9a60650a4debaa32d9a865f341a4">ubrk_isBoundary</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the specfied position is a boundary position. <a href="#132e9a60650a4debaa32d9a865f341a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#c71a66190680632d6e671d0655a006a2">ubrk_getRuleStatus</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the status from the break rule that determined the most recently returned break position. <a href="#c71a66190680632d6e671d0655a006a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ubrk_8h.html#0b5ab4a3322e040c45ea4810ff4f9293">ubrk_getRuleStatusVec</a> (<a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> *fillInVec, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> capacity, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the statuses from the break rules that determined the most recently returned break position. <a href="#0b5ab4a3322e040c45ea4810ff4f9293"></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="ubrk_8h.html#20bddee4564413e283e074b1d3c790ba">ubrk_getLocaleByType</a> (const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> *bi, <a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the locale of the break iterator. <a href="#20bddee4564413e283e074b1d3c790ba"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C API: <a class="el" href="classBreakIterator.html">BreakIterator</a>.
<p>
<h2><a class="el" href="classBreakIterator.html">BreakIterator</a> C API </h2>
<p>
The <a class="el" href="classBreakIterator.html">BreakIterator</a> C API defines methods for finding the location of boundaries in text. Pointer to a UBreakIterator maintain a current position and scan over text returning the index of characters where boundaries occur. <p>
Line boundary analysis determines where a text string can be broken when line-wrapping. The mechanism correctly handles punctuation and hyphenated words. <p>
Sentence boundary analysis allows selection with correct interpretation of periods within numbers and abbreviations, and trailing punctuation marks such as quotation marks and parentheses. <p>
Word boundary analysis is used by search and replace functions, as well as within text editing applications that allow the user to select words with a double click. Word selection provides correct interpretation of punctuation marks within and following words. Characters that are not part of a word, such as symbols or punctuation marks, have word-breaks on both sides. <p>
Character boundary analysis allows users to interact with characters as they expect to, for example, when moving the cursor through a text string. Character boundary analysis provides correct navigation of through character strings, regardless of how the character is stored. For example, an accented character might be stored as a base character and a diacritical mark. What users consider to be a character can differ between languages. <p>
Title boundary analysis locates all positions, typically starts of words, that should be set to Title Case when title casing the text. <p>
The text boundary positions are found according to the rules described in Unicode Standard Annex #29, Text Boundaries, and Unicode Standard Annex #14, Line Breaking Properties. These are available at <a href="http://www.unicode.org/reports/tr14/">http://www.unicode.org/reports/tr14/</a> and <a href="http://www.unicode.org/reports/tr29/.">http://www.unicode.org/reports/tr29/.</a> <p>
In addition to the plain C API defined in this header file, an object oriented C++ API with equivalent functionality is defined in the file <a class="el" href="brkiter_8h.html">brkiter.h</a>. <p>
Code snippits illustrating the use of the Break Iterator APIs are available in the ICU User Guide, <a href="http://icu.sourceforge.net/userguide/boundaryAnalysis.html">http://icu.sourceforge.net/userguide/boundaryAnalysis.html</a> and in the sample program icu/source/samples/break/break.cpp"
<p>
Definition in file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.<hr><h2>Define Documentation</h2>
<a class="anchor" name="51437894cf1d6a00dc9eae70a5ecb638"></a><!-- doxytag: member="ubrk.h::U_BRK_SAFECLONE_BUFFERSIZE" ref="51437894cf1d6a00dc9eae70a5ecb638" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_BRK_SAFECLONE_BUFFERSIZE 512 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A recommended size (in bytes) for the memory buffer to be passed to ubrk_saveClone().
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000388">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00270">270</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<a class="anchor" name="2c3879dff3464e017ea369aaae683663"></a><!-- doxytag: member="ubrk.h::UBRK_DONE" ref="2c3879dff3464e017ea369aaae683663" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UBRK_DONE ((<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a>) -1) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Value indicating all text boundaries have been returned.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000381">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00114">114</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="b3f067cc3bed4e510e064dfc30e1cb73"></a><!-- doxytag: member="ubrk.h::UBreakIterator" ref="b3f067cc3bed4e510e064dfc30e1cb73" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opaque type representing an ICU Break iterator object.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000379">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00025">25</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="9ed6724d16a248ce8b7dd478450760f1"></a><!-- doxytag: member="ubrk.h::UBreakIteratorType" ref="9ed6724d16a248ce8b7dd478450760f1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">UBreakIteratorType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The possible types of text boundaries.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000380">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="9ed6724d16a248ce8b7dd478450760f1ab489e4d6f3c7d30cee4c465aace8ae6"></a><!-- doxytag: member="UBRK_CHARACTER" ref="9ed6724d16a248ce8b7dd478450760f1ab489e4d6f3c7d30cee4c465aace8ae6" args="" -->UBRK_CHARACTER</em> </td><td>
Character breaks.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000404">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="9ed6724d16a248ce8b7dd478450760f19d6d07a19177eb1b5ba9e704685ae4c0"></a><!-- doxytag: member="UBRK_WORD" ref="9ed6724d16a248ce8b7dd478450760f19d6d07a19177eb1b5ba9e704685ae4c0" args="" -->UBRK_WORD</em> </td><td>
Word breaks.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000405">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="9ed6724d16a248ce8b7dd478450760f17b987f9693192e181a10240249e8c3bd"></a><!-- doxytag: member="UBRK_LINE" ref="9ed6724d16a248ce8b7dd478450760f17b987f9693192e181a10240249e8c3bd" args="" -->UBRK_LINE</em> </td><td>
Line breaks.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000406">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="9ed6724d16a248ce8b7dd478450760f184b0a621c9b23cd8669c2ba1b11e031a"></a><!-- doxytag: member="UBRK_SENTENCE" ref="9ed6724d16a248ce8b7dd478450760f184b0a621c9b23cd8669c2ba1b11e031a" args="" -->UBRK_SENTENCE</em> </td><td>
Sentence breaks.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000407">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="9ed6724d16a248ce8b7dd478450760f151071e7772afd935efd328a32798c41b"></a><!-- doxytag: member="UBRK_TITLE" ref="9ed6724d16a248ce8b7dd478450760f151071e7772afd935efd328a32798c41b" args="" -->UBRK_TITLE</em> </td><td>
Title Case breaks The iterator created using this type locates title boundaries as described for Unicode 3.2 only.
<p>
For Unicode 4.0 and above title boundary iteration, please use Word Boundary iterator.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>ICU 2.8 Use the word break iterator for titlecasing for Unicode 4 and later. </dd></dl>
</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00087">87</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<a class="anchor" name="2aa4749c2595dc27c4fccbde8e917b72"></a><!-- doxytag: member="ubrk.h::ULineBreakTag" ref="2aa4749c2595dc27c4fccbde8e917b72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ubrk_8h.html#2aa4749c2595dc27c4fccbde8e917b72">ULineBreakTag</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enum constants for the line break tags returned by getRuleStatus().
<p>
A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values. <dl compact><dt><b><a class="el" href="stable.html#_stable000383">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="2aa4749c2595dc27c4fccbde8e917b72ab47373013dfb58462dd0930e336f4cf"></a><!-- doxytag: member="UBRK_LINE_SOFT" ref="2aa4749c2595dc27c4fccbde8e917b72ab47373013dfb58462dd0930e336f4cf" args="" -->UBRK_LINE_SOFT</em> </td><td>
Tag value for soft line breaks, positions at which a line break is acceptable but not required. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="2aa4749c2595dc27c4fccbde8e917b72376988bdbf7dc51d441cd55ec3f76cd6"></a><!-- doxytag: member="UBRK_LINE_SOFT_LIMIT" ref="2aa4749c2595dc27c4fccbde8e917b72376988bdbf7dc51d441cd55ec3f76cd6" args="" -->UBRK_LINE_SOFT_LIMIT</em> </td><td>
Upper bound for soft line breaks. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="2aa4749c2595dc27c4fccbde8e917b72f2f90bf850ab885ef54f7613e617f190"></a><!-- doxytag: member="UBRK_LINE_HARD" ref="2aa4749c2595dc27c4fccbde8e917b72f2f90bf850ab885ef54f7613e617f190" args="" -->UBRK_LINE_HARD</em> </td><td>
Tag value for a hard, or mandatory line break. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="2aa4749c2595dc27c4fccbde8e917b7284c5f535aaf6d718eb041b3385f396ce"></a><!-- doxytag: member="UBRK_LINE_HARD_LIMIT" ref="2aa4749c2595dc27c4fccbde8e917b7284c5f535aaf6d718eb041b3385f396ce" args="" -->UBRK_LINE_HARD_LIMIT</em> </td><td>
Upper bound for hard line breaks. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00158">158</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<a class="anchor" name="92db8e8e05953ac17ad97a771eea2b2f"></a><!-- doxytag: member="ubrk.h::USentenceBreakTag" ref="92db8e8e05953ac17ad97a771eea2b2f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ubrk_8h.html#92db8e8e05953ac17ad97a771eea2b2f">USentenceBreakTag</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enum constants for the sentence break tags returned by getRuleStatus().
<p>
A range of values is defined for each category of sentence, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values. <dl compact><dt><b><a class="el" href="stable.html#_stable000384">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="92db8e8e05953ac17ad97a771eea2b2f0c70bf2aeba912a2ce639253ed192c13"></a><!-- doxytag: member="UBRK_SENTENCE_TERM" ref="92db8e8e05953ac17ad97a771eea2b2f0c70bf2aeba912a2ce639253ed192c13" args="" -->UBRK_SENTENCE_TERM</em> </td><td>
Tag value for for sentences ending with a sentence terminator ('.
<p>
', '?', '!', etc.) character, possibly followed by a hard separator (CR, LF, PS, etc.) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="92db8e8e05953ac17ad97a771eea2b2f83a6be2df5c8f1b37f17e15d87979456"></a><!-- doxytag: member="UBRK_SENTENCE_TERM_LIMIT" ref="92db8e8e05953ac17ad97a771eea2b2f83a6be2df5c8f1b37f17e15d87979456" args="" -->UBRK_SENTENCE_TERM_LIMIT</em> </td><td>
Upper bound for tags for sentences ended by sentence terminators. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="92db8e8e05953ac17ad97a771eea2b2fe16c873a9f7af8f805b3f5115f8b73d3"></a><!-- doxytag: member="UBRK_SENTENCE_SEP" ref="92db8e8e05953ac17ad97a771eea2b2fe16c873a9f7af8f805b3f5115f8b73d3" args="" -->UBRK_SENTENCE_SEP</em> </td><td>
Tag value for for sentences that do not contain an ending sentence terminator ('.
<p>
', '?', '!', etc.) character, but are ended only by a hard separator (CR, LF, PS, etc.) or end of input. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="92db8e8e05953ac17ad97a771eea2b2f0053103092a1b527bbe8cbc8d931dd48"></a><!-- doxytag: member="UBRK_SENTENCE_SEP_LIMIT" ref="92db8e8e05953ac17ad97a771eea2b2f0053103092a1b527bbe8cbc8d931dd48" args="" -->UBRK_SENTENCE_SEP_LIMIT</em> </td><td>
Upper bound for tags for sentences ended by a separator. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00180">180</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195"></a><!-- doxytag: member="ubrk.h::UWordBreak" ref="1ed8fb30d51d2ee75a17229321e9a195" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ubrk_8h.html#1ed8fb30d51d2ee75a17229321e9a195">UWordBreak</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enum constants for the word break tags returned by getRuleStatus().
<p>
A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values. <dl compact><dt><b><a class="el" href="stable.html#_stable000382">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a19585e3c56a483b3a4a2a69290d4712a28c"></a><!-- doxytag: member="UBRK_WORD_NONE" ref="1ed8fb30d51d2ee75a17229321e9a19585e3c56a483b3a4a2a69290d4712a28c" args="" -->UBRK_WORD_NONE</em> </td><td>
Tag value for "words" that do not fit into any of other categories.
<p>
Includes spaces and most punctuation. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a19570c6d61484b0918ac9bd9af367a60279"></a><!-- doxytag: member="UBRK_WORD_NONE_LIMIT" ref="1ed8fb30d51d2ee75a17229321e9a19570c6d61484b0918ac9bd9af367a60279" args="" -->UBRK_WORD_NONE_LIMIT</em> </td><td>
Upper bound for tags for uncategorized words. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195a8d66bc4ed65b6af62f9b88ce7a1c404"></a><!-- doxytag: member="UBRK_WORD_NUMBER" ref="1ed8fb30d51d2ee75a17229321e9a195a8d66bc4ed65b6af62f9b88ce7a1c404" args="" -->UBRK_WORD_NUMBER</em> </td><td>
Tag value for words that appear to be numbers, lower limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a1956484c83c0ae1cf0af7c070f4d292fb84"></a><!-- doxytag: member="UBRK_WORD_NUMBER_LIMIT" ref="1ed8fb30d51d2ee75a17229321e9a1956484c83c0ae1cf0af7c070f4d292fb84" args="" -->UBRK_WORD_NUMBER_LIMIT</em> </td><td>
Tag value for words that appear to be numbers, upper limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195fecfedc16850228215bd228f08fac546"></a><!-- doxytag: member="UBRK_WORD_LETTER" ref="1ed8fb30d51d2ee75a17229321e9a195fecfedc16850228215bd228f08fac546" args="" -->UBRK_WORD_LETTER</em> </td><td>
Tag value for words that contain letters, excluding hiragana, katakana or ideographic characters, lower limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195a435fe232eedc5eabbb9d0fb1b652884"></a><!-- doxytag: member="UBRK_WORD_LETTER_LIMIT" ref="1ed8fb30d51d2ee75a17229321e9a195a435fe232eedc5eabbb9d0fb1b652884" args="" -->UBRK_WORD_LETTER_LIMIT</em> </td><td>
Tag value for words containing letters, upper limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a1959368c16d6ed2820ddf7afa42035042ed"></a><!-- doxytag: member="UBRK_WORD_KANA" ref="1ed8fb30d51d2ee75a17229321e9a1959368c16d6ed2820ddf7afa42035042ed" args="" -->UBRK_WORD_KANA</em> </td><td>
Tag value for words containing kana characters, lower limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a1953b8c1fb477075b27d2f573151e2c044d"></a><!-- doxytag: member="UBRK_WORD_KANA_LIMIT" ref="1ed8fb30d51d2ee75a17229321e9a1953b8c1fb477075b27d2f573151e2c044d" args="" -->UBRK_WORD_KANA_LIMIT</em> </td><td>
Tag value for words containing kana characters, upper limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195a5a7abfa6f4f01226af00cde1d94c8f0"></a><!-- doxytag: member="UBRK_WORD_IDEO" ref="1ed8fb30d51d2ee75a17229321e9a195a5a7abfa6f4f01226af00cde1d94c8f0" args="" -->UBRK_WORD_IDEO</em> </td><td>
Tag value for words containing ideographic characters, lower limit. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1ed8fb30d51d2ee75a17229321e9a195e91225a285d7fc739fa4871f70410fa9"></a><!-- doxytag: member="UBRK_WORD_IDEO_LIMIT" ref="1ed8fb30d51d2ee75a17229321e9a195e91225a285d7fc739fa4871f70410fa9" args="" -->UBRK_WORD_IDEO_LIMIT</em> </td><td>
Tag value for words containing ideographic characters, upper limit. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="ubrk_8h-source.html#l00125">125</a> of file <a class="el" href="ubrk_8h-source.html">ubrk.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="9ed759eb3daf955551988c92a0b9fe8b"></a><!-- doxytag: member="ubrk.h::ubrk_close" ref="9ed759eb3daf955551988c92a0b9fe8b" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ubrk_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close a UBreakIterator.
<p>
Once closed, a UBreakIterator may no longer be used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to close. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000389">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="894ec55bae57e25af280e6493a3e30d2"></a><!-- doxytag: member="ubrk.h::ubrk_countAvailable" ref="894ec55bae57e25af280e6493a3e30d2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_countAvailable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine how many locales have text breaking information available.
<p>
This function is most useful as determining the loop ending condition for calls to <a class="el" href="ubrk_8h.html#550e2f0c6b28ba39c8d42debfa85e8a3">ubrk_getAvailable</a>. <dl compact><dt><b>Returns:</b></dt><dd>The number of locales for which text breaking information is available. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#550e2f0c6b28ba39c8d42debfa85e8a3">ubrk_getAvailable</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000399">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d1bba7a735be64dcdbdfb79cca3fea2"></a><!-- doxytag: member="ubrk.h::ubrk_current" ref="3d1bba7a735be64dcdbdfb79cca3fea2" args="(const UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_current </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine the most recently-returned text boundary.
<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>bi</em> </td><td>The break iterator to use. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character index most recently returned by <a class="el" href="ubrk_8h.html#1fcb93e30c407933992974e19cd77c72">ubrk_next</a>, <a class="el" href="ubrk_8h.html#e7a4cf3d12c2cefcc342c2ee139fba66">ubrk_previous</a>, <a class="el" href="ubrk_8h.html#f955c40c9d58cedc4b5ebd298a3a49b5">ubrk_first</a>, or <a class="el" href="ubrk_8h.html#e7b75242e744d14e0fdcc63389653eeb">ubrk_last</a>. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000391">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f955c40c9d58cedc4b5ebd298a3a49b5"></a><!-- doxytag: member="ubrk.h::ubrk_first" ref="f955c40c9d58cedc4b5ebd298a3a49b5" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_first </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine the index of the first character in the text being scanned.
<p>
This is not always the same as index 0 of the text. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character index of the first character in the text being scanned. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#e7b75242e744d14e0fdcc63389653eeb">ubrk_last</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000394">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="43ecb05af93098de19e3f48b614e88e3"></a><!-- doxytag: member="ubrk.h::ubrk_following" ref="43ecb05af93098de19e3f48b614e88e3" args="(UBreakIterator *bi, int32_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_following </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</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>
Determine the text boundary following the specified offset.
<p>
The value returned is always greater than offset, or UBRK_DONE. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset to begin scanning. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The text boundary following offset, or UBRK_DONE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#66670badda84913bcf36262dc407bc16">ubrk_preceding</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000397">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="550e2f0c6b28ba39c8d42debfa85e8a3"></a><!-- doxytag: member="ubrk.h::ubrk_getAvailable" ref="550e2f0c6b28ba39c8d42debfa85e8a3" args="(int32_t index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ubrk_getAvailable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a locale for which text breaking information is available.
<p>
A UBreakIterator in a locale returned by this function will perform the correct text breaking for the locale. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The index of the desired locale. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A locale for which number text breaking information is available, or 0 if none. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#894ec55bae57e25af280e6493a3e30d2">ubrk_countAvailable</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000398">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="20bddee4564413e283e074b1d3c790ba"></a><!-- doxytag: member="ubrk.h::ubrk_getLocaleByType" ref="20bddee4564413e283e074b1d3c790ba" args="(const UBreakIterator *bi, ULocDataLocaleType type, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ubrk_getLocaleByType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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>
Return the locale of the break iterator.
<p>
You can choose between the valid and the actual locale. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>break iterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>locale type (valid or actual) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>locale string </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000403">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c71a66190680632d6e671d0655a006a2"></a><!-- doxytag: member="ubrk.h::ubrk_getRuleStatus" ref="c71a66190680632d6e671d0655a006a2" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_getRuleStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the status from the break rule that determined the most recently returned break position.
<p>
The values appear in the rule source within brackets, {123}, for example. For rules that do not specify a status, a default value of 0 is returned. <p>
For word break iterators, the possible values are defined in enum UWordBreak. <dl compact><dt><b><a class="el" href="stable.html#_stable000401">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0b5ab4a3322e040c45ea4810ff4f9293"></a><!-- doxytag: member="ubrk.h::ubrk_getRuleStatusVec" ref="0b5ab4a3322e040c45ea4810ff4f9293" args="(UBreakIterator *bi, int32_t *fillInVec, int32_t capacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_getRuleStatusVec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> * </td>
<td class="paramname"> <em>fillInVec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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>
Get the statuses from the break rules that determined the most recently returned break position.
<p>
The values appear in the rule source within brackets, {123}, for example. The default status value for rules that do not explicitly provide one is zero. <p>
For word break iterators, the possible values are defined in enum UWordBreak. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fillInVec</em> </td><td>an array to be filled in with the status values. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>the length of the supplied vector. A length of zero causes the function to return the number of status values, in the normal way, without attemtping to store any values. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>receives error codes. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of rule status values from rules that determined the most recent boundary returned by the break iterator. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000402">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="132e9a60650a4debaa32d9a865f341a4"></a><!-- doxytag: member="ubrk.h::ubrk_isBoundary" ref="132e9a60650a4debaa32d9a865f341a4" args="(UBreakIterator *bi, int32_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> ubrk_isBoundary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</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>
Returns true if the specfied position is a boundary position.
<p>
As a side effect, leaves the iterator pointing to the first boundary position at or after "offset". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>the offset to check. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if "offset" is a boundary position. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000400">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e7b75242e744d14e0fdcc63389653eeb"></a><!-- doxytag: member="ubrk.h::ubrk_last" ref="e7b75242e744d14e0fdcc63389653eeb" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_last </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine the index immediately <em>beyond</em> the last character in the text being scanned.
<p>
This is not the same as the last character. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character offset immediately <em>beyond</em> the last character in the text being scanned. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#f955c40c9d58cedc4b5ebd298a3a49b5">ubrk_first</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000395">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1fcb93e30c407933992974e19cd77c72"></a><!-- doxytag: member="ubrk.h::ubrk_next" ref="1fcb93e30c407933992974e19cd77c72" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine the text boundary following the current text boundary.
<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>bi</em> </td><td>The break iterator to use. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character index of the next text boundary, or UBRK_DONE if all text boundaries have been returned. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#e7a4cf3d12c2cefcc342c2ee139fba66">ubrk_previous</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000392">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7b60c35a976fe67955124efb68f0ffc0"></a><!-- doxytag: member="ubrk.h::ubrk_open" ref="7b60c35a976fe67955124efb68f0ffc0" args="(UBreakIteratorType type, const char *locale, const UChar *text, int32_t textLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a>* ubrk_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">UBreakIteratorType</a> </td>
<td class="paramname"> <em>type</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">const UChar * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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 new UBreakIterator for locating text boundaries for a specified locale.
<p>
A UBreakIterator may be used for detecting character, line, word, and sentence breaks in text. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The type of UBreakIterator to open: one of UBRK_CHARACTER, UBRK_WORD, UBRK_LINE, UBRK_SENTENCE </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>The locale specifying the text-breaking conventions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text to be iterated over. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLength</em> </td><td>The number of characters in text, or -1 if null-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A UBreakIterator for the specified locale. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#fdb60f731ef47f5287f84b79917e38d7">ubrk_openRules</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000385">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdb60f731ef47f5287f84b79917e38d7"></a><!-- doxytag: member="ubrk.h::ubrk_openRules" ref="fdb60f731ef47f5287f84b79917e38d7" args="(const UChar *rules, int32_t rulesLength, const UChar *text, int32_t textLength, UParseError *parseErr, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a>* ubrk_openRules </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>rulesLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"> <em>parseErr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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 new UBreakIterator for locating text boundaries using specified breaking rules.
<p>
The rule syntax is ... (TBD) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rules</em> </td><td>A set of rules specifying the text breaking conventions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rulesLength</em> </td><td>The number of characters in rules, or -1 if null-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text to be iterated over. May be null, in which case <a class="el" href="ubrk_8h.html#dc1a24f65f52180dfe059c3849bcda49">ubrk_setText()</a> is used to specify the text to be iterated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLength</em> </td><td>The number of characters in text, or -1 if null-terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseErr</em> </td><td>Receives position and context information for any syntax errors detected while parsing the rules. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A UBreakIterator for the specified rules. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#7b60c35a976fe67955124efb68f0ffc0">ubrk_open</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000386">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="66670badda84913bcf36262dc407bc16"></a><!-- doxytag: member="ubrk.h::ubrk_preceding" ref="66670badda84913bcf36262dc407bc16" args="(UBreakIterator *bi, int32_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_preceding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</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>
Determine the text boundary preceding the specified offset.
<p>
The value returned is always smaller than offset, or UBRK_DONE. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bi</em> </td><td>The break iterator to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset to begin scanning. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The text boundary preceding offset, or UBRK_DONE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#43ecb05af93098de19e3f48b614e88e3">ubrk_following</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000396">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e7a4cf3d12c2cefcc342c2ee139fba66"></a><!-- doxytag: member="ubrk.h::ubrk_previous" ref="e7a4cf3d12c2cefcc342c2ee139fba66" args="(UBreakIterator *bi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ubrk_previous </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine the text boundary preceding the current text boundary.
<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>bi</em> </td><td>The break iterator to use. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The character index of the preceding text boundary, or UBRK_DONE if all text boundaries have been returned. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ubrk_8h.html#1fcb93e30c407933992974e19cd77c72">ubrk_next</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000393">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2c8803c1611d35a02f8b6c563894e848"></a><!-- doxytag: member="ubrk.h::ubrk_safeClone" ref="2c8803c1611d35a02f8b6c563894e848" args="(const UBreakIterator *bi, void *stackBuffer, int32_t *pBufferSize, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a>* ubrk_safeClone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>stackBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> * </td>
<td class="paramname"> <em>pBufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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>
Thread safe cloning operation.
<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>bi</em> </td><td>iterator to be cloned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stackBuffer</em> </td><td>user allocated space for the new clone. If NULL new memory will be allocated. If buffer is not large enough, new memory will be allocated. Clients can use the U_BRK_SAFECLONE_BUFFERSIZE. This will probably be enough to avoid memory allocations. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pBufferSize</em> </td><td>pointer to size of allocated space. If *pBufferSize == 0, a sufficient size for use in cloning will be returned ('pre-flighting') If *pBufferSize is not enough for a stack-based safe clone, new memory will be allocated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>to indicate whether the operation went on smoothly or there were errors An informational status value, U_SAFECLONE_ALLOCATED_ERROR, is used if any allocations were necessary. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>pointer to the new clone </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000387">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="dc1a24f65f52180dfe059c3849bcda49"></a><!-- doxytag: member="ubrk.h::ubrk_setText" ref="dc1a24f65f52180dfe059c3849bcda49" args="(UBreakIterator *bi, const UChar *text, int32_t textLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ubrk_setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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>
Sets an existing iterator to point to a new piece of text.
<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>bi</em> </td><td>The iterator to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text to be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLength</em> </td><td>The length of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000390">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0aa35691e73c054712950489496e4d21"></a><!-- doxytag: member="ubrk.h::ubrk_setUText" ref="0aa35691e73c054712950489496e4d21" args="(UBreakIterator *bi, UText *text, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ubrk_setUText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ustring_8h.html#b3f067cc3bed4e510e064dfc30e1cb73">UBreakIterator</a> * </td>
<td class="paramname"> <em>bi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUText.html">UText</a> * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>status</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>
Sets an existing iterator to point to a new piece of text.
<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>bi</em> </td><td>The iterator to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text to be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000033">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.4 </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:51 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
