<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ICU 4.4: usearch.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>usearch.h File Reference</h1>
<p>C API: <a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a>.
<a href="#_details">More...</a></p>
<code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/>
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
<code>#include "<a class="el" href="ucol_8h_source.html">unicode/ucol.h</a>"</code><br/>
<code>#include "<a class="el" href="ucoleitr_8h_source.html">unicode/ucoleitr.h</a>"</code><br/>
<code>#include "<a class="el" href="ubrk_8h_source.html">unicode/ubrk.h</a>"</code><br/>
<p><a href="usearch_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa">USEARCH_DONE</a> -1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all. <a href="#ab66c48ad34ba3832680f23da3e0f70aa"></a><br/></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data structure for searching. <a href="#ab244c09051ecef7e477be6f3e247796d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> { <a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03a5ff7dd21e97fe37e8c0831e01109ac4d">USEARCH_OVERLAP</a>,
<a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03a37b8d3d23099f977933aba4ee4eeff4c">USEARCH_CANONICAL_MATCH</a>,
<a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03a5913e7fe1dd4718633825ffc3c7eb58d">USEARCH_ELEMENT_COMPARISON</a>,
<b>USEARCH_ATTRIBUTE_COUNT</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> { <br/>
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1a4195142bbaf07c3e7503a4017deab57b">USEARCH_DEFAULT</a> = -1,
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1a5c12e5024dc8193f02f5961d9997ecc5">USEARCH_OFF</a>,
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1a683745df041ae94d9b0450c08d030fb7">USEARCH_ON</a>,
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1aaaa3f2ca0131d2dac6cda0af4c53903e">USEARCH_STANDARD_ELEMENT_COMPARISON</a>,
<br/>
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1ad657b25a9167aad29f36acdbcb65d155">USEARCH_PATTERN_BASE_WEIGHT_IS_WILDCARD</a>,
<a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1adfcf458c299700c875bbb28ca558506f">USEARCH_ANY_BASE_WEIGHT_IS_WILDCARD</a>,
<b>USEARCH_ATTRIBUTE_VALUE_COUNT</b>
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a25915409c9af820aef82990b82b401d7">usearch_open</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pattern, int32_t patternlength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t textlength, const char *locale, <a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> *breakiter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creating a search iterator data struct using the argument locale language rule set. <a href="#a25915409c9af820aef82990b82b401d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a5cfb0c54ef2b4bf100ce5f1febf769cc">usearch_openFromCollator</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pattern, int32_t patternlength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t textlength, const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *collator, <a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> *breakiter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creating a search iterator data struct using the argument collator language rule set. <a href="#a5cfb0c54ef2b4bf100ce5f1febf769cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a618a3f90394cecd1f76aaee4cc1b4c9d">usearch_close</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *searchiter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroying and cleaning up the search iterator data struct. <a href="#a618a3f90394cecd1f76aaee4cc1b4c9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a1291f11a16b4b1090eb7029e4c51c70a">usearch_setOffset</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the current position in the text string which the next search will start from. <a href="#a1291f11a16b4b1090eb7029e4c51c70a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622">usearch_getOffset</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current index in the string text being searched. <a href="#ad5913a0eff26b126630d802195fa4622"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ac983c4347f0d3d0179d67f0e9ba47bd0">usearch_setAttribute</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> attribute, <a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> value, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue. <a href="#ac983c4347f0d3d0179d67f0e9ba47bd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a22948a4f2340979d38e145e13efb7a86">usearch_getAttribute</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> attribute)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the text searching attributes. <a href="#a22948a4f2340979d38e145e13efb7a86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a87337f2e0925028965f9f4ff72463eab">usearch_getMatchedStart</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index to the match in the text string that was searched. <a href="#a87337f2e0925028965f9f4ff72463eab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a4a88cb2386508803670df932384ed195">usearch_getMatchedLength</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of text in the string which matches the search pattern. <a href="#a4a88cb2386508803670df932384ed195"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a19a7079e52d937fc2ea7fe5e06a2c563">usearch_getMatchedText</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *result, int32_t resultCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the text that was matched by the most recent call to <code>usearch_first</code>, <code>usearch_next</code>, <code>usearch_previous</code>, or <code>usearch_last</code>. <a href="#a19a7079e52d937fc2ea7fe5e06a2c563"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a86d42a1e90bb714a38a314d5bb77cda5">usearch_setBreakIterator</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> *breakiter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. <a href="#a86d42a1e90bb714a38a314d5bb77cda5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a1386c96d1215f380a0678bf368efbbba">usearch_getBreakIterator</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that is used to restrict the points at which matches are detected. <a href="#a1386c96d1215f380a0678bf368efbbba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a09c1c5d4ea8b69ce32993dff6426a386">usearch_setText</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t textlength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the string text to be searched. <a href="#a09c1c5d4ea8b69ce32993dff6426a386"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a4c0acb3936f46b566e39874e6f063f1b">usearch_getText</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t *length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string text to be searched. <a href="#a4c0acb3936f46b566e39874e6f063f1b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ac6c5c26c83f1797d7d60befad91ca2d3">usearch_getCollator</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the collator used for the language rules. <a href="#ac6c5c26c83f1797d7d60befad91ca2d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ac54be8b9a44d22ec6ea5d53f3cc5d7c5">usearch_setCollator</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *collator, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the collator used for the language rules. <a href="#ac54be8b9a44d22ec6ea5d53f3cc5d7c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#aa2d53cd40c636eb0da13b891e4a84dbb">usearch_setPattern</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pattern, int32_t patternlength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the pattern used for matching. <a href="#aa2d53cd40c636eb0da13b891e4a84dbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a1ffeb4ed9b997387051c1705b2b32858">usearch_getPattern</a> (const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t *length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the search pattern. <a href="#a1ffeb4ed9b997387051c1705b2b32858"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4">usearch_first</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index at which the string text matches the search pattern. <a href="#ad59a7f4746faf28c98fee8473e0353d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a32c4c29b24f1f2ce0a3dc4e90c1a0b30">usearch_following</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index greater than <code>position</code> at which the string text matches the search pattern. <a href="#a32c4c29b24f1f2ce0a3dc4e90c1a0b30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#aad61fadd096cd28a454f68fa117a24cb">usearch_last</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the last index in the target text at which it matches the search pattern. <a href="#aad61fadd096cd28a454f68fa117a24cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#ac3cd326f313fdc57bfe46f906a33f6f1">usearch_preceding</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index less than <code>position</code> at which the string text matches the search pattern. <a href="#ac3cd326f313fdc57bfe46f906a33f6f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a51f8b08f582cb956d950cdd5098e93cf">usearch_next</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the next point at which the string text matches the search pattern, starting from the current position. <a href="#a51f8b08f582cb956d950cdd5098e93cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a6be0c1c2f412c0ae13cb9c7c1796d7a4">usearch_previous</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the previous point at which the string text matches the search pattern, starting at the current position. <a href="#a6be0c1c2f412c0ae13cb9c7c1796d7a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a52484e482e408ddc091cc43b0d1decd9">usearch_reset</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the iteration. <a href="#a52484e482e408ddc091cc43b0d1decd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#a429ec33f40f29f25d41ce8a1f7513465">usearch_search</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t startIdx, int32_t *matchStart, int32_t *matchLimit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simple forward search for the pattern, starting at a specified index, and using using a default set search options. <a href="#a429ec33f40f29f25d41ce8a1f7513465"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usearch_8h.html#aafad5d71a67ca39ba1886fbae3659a5b">usearch_searchBackwards</a> (<a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> *strsrch, int32_t startIdx, int32_t *matchStart, int32_t *matchLimit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simple backwards search for the pattern, starting at a specified index, and using using a default set search options. <a href="#aafad5d71a67ca39ba1886fbae3659a5b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C API: <a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a>. </p>
<p>C Apis for an engine that provides language-sensitive text searching based on the comparison rules defined in a <code>UCollator</code> data struct, see <code><a class="el" href="ucol_8h.html" title="C API: Collator.">ucol.h</a></code>. This ensures that language eccentricity can be handled, e.g. for the German collator, characters ß and SS will be matched if case is chosen to be ignored. See the <a href="http://source.icu-project.org/repos/icu/icuhtml/trunk/design/collation/ICU_collation_design.htm">"ICU Collation Design Document"</a> for more information. </p>
<p>The algorithm implemented is a modified form of the Boyer Moore's search. For more information see <a href="http://icu-project.org/docs/papers/efficient_text_searching_in_java.html">"Efficient Text Searching in Java"</a>, published in <em>Java Report</em> in February, 1999, for further information on the algorithm. </p>
<p>There are 2 match options for selection:<br/>
Let S' be the sub-string of a text string S between the offsets start and end <start, end>. <br/>
A pattern string P matches a text string S at the offsets <start, end> if </p>
<pre>
option 1. Some canonical equivalent of P matches some canonical equivalent
of S'
option 2. P matches S' and if P starts or ends with a combining mark,
there exists no non-ignorable combining mark before or after S'
in S respectively.
</pre><p> Option 2. will be the default. </p>
<p>This search has APIs similar to that of other text iteration mechanisms such as the break iterators in <code><a class="el" href="ubrk_8h.html" title="C API: BreakIterator.">ubrk.h</a></code>. Using these APIs, it is easy to scan through text looking for all occurances of a given pattern. This search iterator allows changing of direction by calling a <code>reset</code> followed by a <code>next</code> or <code>previous</code>. Though a direction change can occur without calling <code>reset</code> first, this operation comes with some speed penalty. Generally, match results in the forward direction will match the result matches in the backwards direction in the reverse order </p>
<p><code><a class="el" href="usearch_8h.html" title="C API: StringSearch.">usearch.h</a></code> provides APIs to specify the starting position within the text string to be searched, e.g. <code>usearch_setOffset</code>, <code>usearch_preceding</code> and <code>usearch_following</code>. Since the starting position will be set as it is specified, please take note that there are some dangerous positions which the search may render incorrect results: </p>
<ul>
<li>
The midst of a substring that requires normalization. </li>
<li>
If the following match is to be found, the position should not be the second character which requires to be swapped with the preceding character. Vice versa, if the preceding match is to be found, position to search from should not be the first character which requires to be swapped with the next character. E.g certain Thai and Lao characters require swapping. </li>
<li>
If a following pattern match is to be found, any position within a contracting sequence except the first will fail. Vice versa if a preceding pattern match is to be found, a invalid starting point would be any character within a contracting sequence except the last. </li>
</ul>
<p>A breakiterator can be used if only matches at logical breaks are desired. Using a breakiterator will only give you results that exactly matches the boundaries given by the breakiterator. For instance the pattern "e" will not be found in the string "\u00e9" if a character break iterator is used. </p>
<p>Options are provided to handle overlapping matches. E.g. In English, overlapping matches produces the result 0 and 2 for the pattern "abab" in the text "ababab", where else mutually exclusive matches only produce the result of 0. </p>
<p>Though collator attributes will be taken into consideration while performing matches, there are no APIs here for setting and getting the attributes. These attributes can be set by getting the collator from <code>usearch_getCollator</code> and using the APIs in <code><a class="el" href="ucol_8h.html" title="C API: Collator.">ucol.h</a></code>. Lastly to update String Search to the new collator attributes, <a class="el" href="usearch_8h.html#a52484e482e408ddc091cc43b0d1decd9" title="Reset the iteration.">usearch_reset()</a> has to be called. </p>
<p>Restriction: <br/>
Currently there are no composite characters that consists of a character with combining class > 0 before a character with combining class == 0. However, if such a character exists in the future, the search mechanism does not guarantee the results for option 1.</p>
<p>Example of use:<br/>
</p>
<pre><code>
char *tgtstr = "The quick brown fox jumped over the lazy fox";
char *patstr = "fox";
UChar target[64];
UChar pattern[16];
UErrorCode status = U_ZERO_ERROR;
u_uastrcpy(target, tgtstr);
u_uastrcpy(pattern, patstr);</code></pre><pre><code> UStringSearch *search = usearch_open(pattern, -1, target, -1, "en_US",
NULL, &status);
if (<a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS(status)</a>) {
for (int pos = usearch_first(search, &status);
pos != USEARCH_DONE;
pos = usearch_next(search, &status))
{
printf("Found match at %d pos, length is %d\n", pos,
usearch_getMatchLength(search));
}
}</code></pre><pre><code> usearch_close(search);
</code></pre> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003842">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition in file <a class="el" href="usearch_8h_source.html">usearch.h</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ab66c48ad34ba3832680f23da3e0f70aa"></a><!-- doxytag: member="usearch.h::USEARCH_DONE" ref="ab66c48ad34ba3832680f23da3e0f70aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USEARCH_DONE -1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003843">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="usearch_8h_source.html#l00140">140</a> of file <a class="el" href="usearch_8h_source.html">usearch.h</a>.</p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ab244c09051ecef7e477be6f3e247796d"></a><!-- doxytag: member="usearch.h::UStringSearch" ref="ab244c09051ecef7e477be6f3e247796d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data structure for searching. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003845">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="usearch_8h_source.html#l00151">151</a> of file <a class="el" href="usearch_8h_source.html">usearch.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="aa382f146f1968a9d1dc182100b23ac03"></a><!-- doxytag: member="usearch.h::USearchAttribute" ref="aa382f146f1968a9d1dc182100b23ac03" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003846">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aa382f146f1968a9d1dc182100b23ac03a5ff7dd21e97fe37e8c0831e01109ac4d"></a><!-- doxytag: member="USEARCH_OVERLAP" ref="aa382f146f1968a9d1dc182100b23ac03a5ff7dd21e97fe37e8c0831e01109ac4d" args="" -->USEARCH_OVERLAP</em> </td><td>
<p>Option for overlapping matches. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa382f146f1968a9d1dc182100b23ac03a37b8d3d23099f977933aba4ee4eeff4c"></a><!-- doxytag: member="USEARCH_CANONICAL_MATCH" ref="aa382f146f1968a9d1dc182100b23ac03a37b8d3d23099f977933aba4ee4eeff4c" args="" -->USEARCH_CANONICAL_MATCH</em> </td><td>
<p>Option for canonical matches. </p>
<p>option 1 in header documentation. The default value will be USEARCH_OFF </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa382f146f1968a9d1dc182100b23ac03a5913e7fe1dd4718633825ffc3c7eb58d"></a><!-- doxytag: member="USEARCH_ELEMENT_COMPARISON" ref="aa382f146f1968a9d1dc182100b23ac03a5913e7fe1dd4718633825ffc3c7eb58d" args="" -->USEARCH_ELEMENT_COMPARISON</em> </td><td>
<p>Option to control how collation elements are compared. </p>
<p>The default value will be USEARCH_STANDARD_ELEMENT_COMPARISON. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000243">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="usearch_8h_source.html#l00156">156</a> of file <a class="el" href="usearch_8h_source.html">usearch.h</a>.</p>
</div>
</div>
<a class="anchor" id="afbe777746540a229c0a2ff3323e292d1"></a><!-- doxytag: member="usearch.h::USearchAttributeValue" ref="afbe777746540a229c0a2ff3323e292d1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003847">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1a4195142bbaf07c3e7503a4017deab57b"></a><!-- doxytag: member="USEARCH_DEFAULT" ref="afbe777746540a229c0a2ff3323e292d1a4195142bbaf07c3e7503a4017deab57b" args="" -->USEARCH_DEFAULT</em> </td><td>
<p>Default value for any USearchAttribute. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1a5c12e5024dc8193f02f5961d9997ecc5"></a><!-- doxytag: member="USEARCH_OFF" ref="afbe777746540a229c0a2ff3323e292d1a5c12e5024dc8193f02f5961d9997ecc5" args="" -->USEARCH_OFF</em> </td><td>
<p>Value for USEARCH_OVERLAP and USEARCH_CANONICAL_MATCH. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1a683745df041ae94d9b0450c08d030fb7"></a><!-- doxytag: member="USEARCH_ON" ref="afbe777746540a229c0a2ff3323e292d1a683745df041ae94d9b0450c08d030fb7" args="" -->USEARCH_ON</em> </td><td>
<p>Value for USEARCH_OVERLAP and USEARCH_CANONICAL_MATCH. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1aaaa3f2ca0131d2dac6cda0af4c53903e"></a><!-- doxytag: member="USEARCH_STANDARD_ELEMENT_COMPARISON" ref="afbe777746540a229c0a2ff3323e292d1aaaa3f2ca0131d2dac6cda0af4c53903e" args="" -->USEARCH_STANDARD_ELEMENT_COMPARISON</em> </td><td>
<p>Value (default) for USEARCH_ELEMENT_COMPARISON; standard collation element comparison at the specified collator strength. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000244">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1ad657b25a9167aad29f36acdbcb65d155"></a><!-- doxytag: member="USEARCH_PATTERN_BASE_WEIGHT_IS_WILDCARD" ref="afbe777746540a229c0a2ff3323e292d1ad657b25a9167aad29f36acdbcb65d155" args="" -->USEARCH_PATTERN_BASE_WEIGHT_IS_WILDCARD</em> </td><td>
<p>Value for USEARCH_ELEMENT_COMPARISON; collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1. </p>
<p>Collation elements in the pattern that have the base weight for the specified strength are treated as "wildcards" that match an element with any other weight at that collation level in the searched text. For example, with a secondary-strength English collator, a plain 'e' in the pattern will match a plain e or an e with any diacritic in the searched text, but an e with diacritic in the pattern will only match an e with the same diacritic in the searched text. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000245">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="afbe777746540a229c0a2ff3323e292d1adfcf458c299700c875bbb28ca558506f"></a><!-- doxytag: member="USEARCH_ANY_BASE_WEIGHT_IS_WILDCARD" ref="afbe777746540a229c0a2ff3323e292d1adfcf458c299700c875bbb28ca558506f" args="" -->USEARCH_ANY_BASE_WEIGHT_IS_WILDCARD</em> </td><td>
<p>Value for USEARCH_ELEMENT_COMPARISON. </p>
<p>collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1. Collation elements in either the pattern or the searched text that have the base weight for the specified strength are treated as "wildcards" that match an element with any other weight at that collation level. For example, with a secondary-strength English collator, a plain 'e' in the pattern will match a plain e or an e with any diacritic in the searched text, but an e with diacritic in the pattern will only match an e with the same diacritic or a plain e in the searched text. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000246">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="usearch_8h_source.html#l00177">177</a> of file <a class="el" href="usearch_8h_source.html">usearch.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a618a3f90394cecd1f76aaee4cc1b4c9d"></a><!-- doxytag: member="usearch.h::usearch_close" ref="a618a3f90394cecd1f76aaee4cc1b4c9d" args="(UStringSearch *searchiter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>searchiter</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroying and cleaning up the search iterator data struct. </p>
<p>If a collator is created in <code>usearch_open</code>, it will be destroyed here. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>searchiter</em> </td><td>data struct to clean up </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003850">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ad59a7f4746faf28c98fee8473e0353d4"></a><!-- doxytag: member="usearch.h::usearch_first" ref="ad59a7f4746faf28c98fee8473e0353d4" args="(UStringSearch *strsrch, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_first </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003866">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a32c4c29b24f1f2ce0a3dc4e90c1a0b30"></a><!-- doxytag: member="usearch.h::usearch_following" ref="a32c4c29b24f1f2ce0a3dc4e90c1a0b30" args="(UStringSearch *strsrch, int32_t position, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_following </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index greater than <code>position</code> at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code> </p>
<p>Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>to start the search at </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match following <code>pos</code>, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003867">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a22948a4f2340979d38e145e13efb7a86"></a><!-- doxytag: member="usearch.h::usearch_getAttribute" ref="a22948a4f2340979d38e145e13efb7a86" args="(const UStringSearch *strsrch, USearchAttribute attribute)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> usearch_getAttribute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> </td>
<td class="paramname"> <em>attribute</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the text searching attributes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attribute</em> </td><td>text attribute to be retrieve </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>text attribute value </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ac983c4347f0d3d0179d67f0e9ba47bd0" title="Sets the text searching attributes located in the enum USearchAttribute with values...">usearch_setAttribute</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003854">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a1386c96d1215f380a0678bf368efbbba"></a><!-- doxytag: member="usearch.h::usearch_getBreakIterator" ref="a1386c96d1215f380a0678bf368efbbba" args="(const UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a>* usearch_getBreakIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that is used to restrict the points at which matches are detected. </p>
<p>This will be the same object that was passed to the constructor or to <code>usearch_setBreakIterator</code>. Note that <code>NULL</code> is a legal value; it means that break detection should not be attempted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>break iterator used </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#a86d42a1e90bb714a38a314d5bb77cda5" title="Set the BreakIterator that will be used to restrict the points at which matches are...">usearch_setBreakIterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003859">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac6c5c26c83f1797d7d60befad91ca2d3"></a><!-- doxytag: member="usearch.h::usearch_getCollator" ref="ac6c5c26c83f1797d7d60befad91ca2d3" args="(const UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* usearch_getCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the collator used for the language rules. </p>
<p>Deleting the returned <code>UCollator</code> before calling <code>usearch_close</code> would cause the string search to fail. <code>usearch_close</code> will delete the collator if this search owns it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>collator </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003862">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a4a88cb2386508803670df932384ed195"></a><!-- doxytag: member="usearch.h::usearch_getMatchedLength" ref="a4a88cb2386508803670df932384ed195" args="(const UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_getMatchedLength </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the length of text in the string which matches the search pattern. </p>
<p>This call returns a valid result only after a successful call to <code>usearch_first</code>, <code>usearch_next</code>, <code>usearch_previous</code>, or <code>usearch_last</code>. Just after construction, or after a searching method returns <code>USEARCH_DONE</code>, this method will return 0. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the match in the string text, or 0 if there is no match currently. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4" title="Returns the first index at which the string text matches the search pattern.">usearch_first</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a51f8b08f582cb956d950cdd5098e93cf" title="Returns the index of the next point at which the string text matches the search pattern...">usearch_next</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a6be0c1c2f412c0ae13cb9c7c1796d7a4" title="Returns the index of the previous point at which the string text matches the search...">usearch_previous</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#aad61fadd096cd28a454f68fa117a24cb" title="Returns the last index in the target text at which it matches the search pattern...">usearch_last</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003856">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a87337f2e0925028965f9f4ff72463eab"></a><!-- doxytag: member="usearch.h::usearch_getMatchedStart" ref="a87337f2e0925028965f9f4ff72463eab" args="(const UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_getMatchedStart </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index to the match in the text string that was searched. </p>
<p>This call returns a valid result only after a successful call to <code>usearch_first</code>, <code>usearch_next</code>, <code>usearch_previous</code>, or <code>usearch_last</code>. Just after construction, or after a searching method returns <code>USEARCH_DONE</code>, this method will return <code>USEARCH_DONE</code>. </p>
<p>Use <code>usearch_getMatchedLength</code> to get the matched string length. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>index to a substring within the text string that is being searched. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4" title="Returns the first index at which the string text matches the search pattern.">usearch_first</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a51f8b08f582cb956d950cdd5098e93cf" title="Returns the index of the next point at which the string text matches the search pattern...">usearch_next</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a6be0c1c2f412c0ae13cb9c7c1796d7a4" title="Returns the index of the previous point at which the string text matches the search...">usearch_previous</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#aad61fadd096cd28a454f68fa117a24cb" title="Returns the last index in the target text at which it matches the search pattern...">usearch_last</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003855">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a19a7079e52d937fc2ea7fe5e06a2c563"></a><!-- doxytag: member="usearch.h::usearch_getMatchedText" ref="a19a7079e52d937fc2ea7fe5e06a2c563" args="(const UStringSearch *strsrch, UChar *result, int32_t resultCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_getMatchedText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>resultCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the text that was matched by the most recent call to <code>usearch_first</code>, <code>usearch_next</code>, <code>usearch_previous</code>, or <code>usearch_last</code>. </p>
<p>If the iterator is not pointing at a valid match (e.g. just after construction or after <code>USEARCH_DONE</code> has been returned, returns an empty string. If result is not large enough to store the matched text, result will be filled with the partial text and an U_BUFFER_OVERFLOW_ERROR will be returned in status. result will be null-terminated whenever possible. If the buffer fits the matched text exactly, a null-termination is not possible, then a U_STRING_NOT_TERMINATED_ERROR set in status. Pre-flighting can be either done with length = 0 or the API <code>usearch_getMatchLength</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>UChar buffer to store the matched string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultCapacity</em> </td><td>length of the result buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error returned if result is not large enough </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>exact length of the matched text, not counting the null-termination </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4" title="Returns the first index at which the string text matches the search pattern.">usearch_first</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a51f8b08f582cb956d950cdd5098e93cf" title="Returns the index of the next point at which the string text matches the search pattern...">usearch_next</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#a6be0c1c2f412c0ae13cb9c7c1796d7a4" title="Returns the index of the previous point at which the string text matches the search...">usearch_previous</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#aad61fadd096cd28a454f68fa117a24cb" title="Returns the last index in the target text at which it matches the search pattern...">usearch_last</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003857">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ad5913a0eff26b126630d802195fa4622"></a><!-- doxytag: member="usearch.h::usearch_getOffset" ref="ad5913a0eff26b126630d802195fa4622" args="(const UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_getOffset </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current index in the string text being searched. </p>
<p>If the iteration has gone past the end of the text (or past the beginning for a backwards search), <code>USEARCH_DONE</code> is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003852">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a1ffeb4ed9b997387051c1705b2b32858"></a><!-- doxytag: member="usearch.h::usearch_getPattern" ref="a1ffeb4ed9b997387051c1705b2b32858" args="(const UStringSearch *strsrch, int32_t *length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* usearch_getPattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the search pattern. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>return length of the pattern, -1 indicates that the pattern is null-terminated </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pattern string </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003865">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a4c0acb3936f46b566e39874e6f063f1b"></a><!-- doxytag: member="usearch.h::usearch_getText" ref="a4c0acb3936f46b566e39874e6f063f1b" args="(const UStringSearch *strsrch, int32_t *length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* usearch_getText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the string text to be searched. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>returned string text length </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string text </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#a09c1c5d4ea8b69ce32993dff6426a386" title="Set the string text to be searched.">usearch_setText</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003861">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aad61fadd096cd28a454f68fa117a24cb"></a><!-- doxytag: member="usearch.h::usearch_last" ref="aad61fadd096cd28a454f68fa117a24cb" args="(UStringSearch *strsrch, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_last </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the last index in the target text at which it matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the first match, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003868">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a51f8b08f582cb956d950cdd5098e93cf"></a><!-- doxytag: member="usearch.h::usearch_next" ref="a51f8b08f582cb956d950cdd5098e93cf" args="(UStringSearch *strsrch, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index of the next point at which the string text matches the search pattern, starting from the current position. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code> </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the next match after the current position, or <code>USEARCH_DONE</code> if there are no more matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4" title="Returns the first index at which the string text matches the search pattern.">usearch_first</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003870">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a25915409c9af820aef82990b82b401d7"></a><!-- doxytag: member="usearch.h::usearch_open" ref="a25915409c9af820aef82990b82b401d7" args="(const UChar *pattern, int32_t patternlength, const UChar *text, int32_t textlength, const char *locale, UBreakIterator *breakiter, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a>* usearch_open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>patternlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>textlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creating a search iterator data struct using the argument locale language rule set. </p>
<p>A collator will be created in the process, which will be owned by this search and will be deleted in <code>usearch_close</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>for matching </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patternlength</em> </td><td>length of the pattern, -1 for null-termination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>text string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textlength</em> </td><td>length of the text string, -1 for null-termination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>name of locale for the rules to be used </td></tr>
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match will be rejected and another will be searched for. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs. If pattern or text is NULL, or if patternlength or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>search iterator data structure, or NULL if there is an error. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003848">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a5cfb0c54ef2b4bf100ce5f1febf769cc"></a><!-- doxytag: member="usearch.h::usearch_openFromCollator" ref="a5cfb0c54ef2b4bf100ce5f1febf769cc" args="(const UChar *pattern, int32_t patternlength, const UChar *text, int32_t textlength, const UCollator *collator, UBreakIterator *breakiter, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a>* usearch_openFromCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>patternlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>textlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"> <em>collator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creating a search iterator data struct using the argument collator language rule set. </p>
<p>Note, user retains the ownership of this collator, thus the responsibility of deletion lies with the user. NOTE: string search cannot be instantiated from a collator that has collate digits as numbers (CODAN) turned on. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>for matching </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patternlength</em> </td><td>length of the pattern, -1 for null-termination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>text string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textlength</em> </td><td>length of the text string, -1 for null-termination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>collator</em> </td><td>used for the language rules </td></tr>
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match will be rejected and another will be searched for. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs. If collator, pattern or text is NULL, or if patternlength or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>search iterator data structure, or NULL if there is an error. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003849">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac3cd326f313fdc57bfe46f906a33f6f1"></a><!-- doxytag: member="usearch.h::usearch_preceding" ref="ac3cd326f313fdc57bfe46f906a33f6f1" args="(UStringSearch *strsrch, int32_t position, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_preceding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index less than <code>position</code> at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code> </p>
<p>Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>index position the search is to begin at </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match preceding <code>pos</code>, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003869">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a6be0c1c2f412c0ae13cb9c7c1796d7a4"></a><!-- doxytag: member="usearch.h::usearch_previous" ref="a6be0c1c2f412c0ae13cb9c7c1796d7a4" args="(UStringSearch *strsrch, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t usearch_previous </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index of the previous point at which the string text matches the search pattern, starting at the current position. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>usearch_getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index <code>USEARCH_DONE</code> </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the previous match before the current position, or <code>USEARCH_DONE</code> if there are no more matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#aad61fadd096cd28a454f68fa117a24cb" title="Returns the last index in the target text at which it matches the search pattern...">usearch_last</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ad5913a0eff26b126630d802195fa4622" title="Return the current index in the string text being searched.">usearch_getOffset</a> </dd>
<dd>
<a class="el" href="usearch_8h.html#ab66c48ad34ba3832680f23da3e0f70aa" title="DONE is returned by previous() and next() after all valid matches have been returned...">USEARCH_DONE</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003871">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a52484e482e408ddc091cc43b0d1decd9"></a><!-- doxytag: member="usearch.h::usearch_reset" ref="a52484e482e408ddc091cc43b0d1decd9" args="(UStringSearch *strsrch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the iteration. </p>
<p>Search will begin at the start of the text string if a forward iteration is initiated before a backwards iteration. Otherwise if a backwards iteration is initiated before a forwards iteration, the search will begin at the end of the text string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#ad59a7f4746faf28c98fee8473e0353d4" title="Returns the first index at which the string text matches the search pattern.">usearch_first</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003872">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a429ec33f40f29f25d41ce8a1f7513465"></a><!-- doxytag: member="usearch.h::usearch_search" ref="a429ec33f40f29f25d41ce8a1f7513465" args="(UStringSearch *strsrch, int32_t startIdx, int32_t *matchStart, int32_t *matchLimit, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> usearch_search </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>startIdx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>matchStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>matchLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simple forward search for the pattern, starting at a specified index, and using using a default set search options. </p>
<p>This is an experimental function, and is not an official part of the ICU API.</p>
<p>The collator options, such as UCOL_STRENGTH and UCOL_NORMALIZTION, are honored.</p>
<p>The UStringSearch options USEARCH_CANONICAL_MATCH, USEARCH_OVERLAP and any Break Iterator are ignored.</p>
<p>Matches obey the following constraints:</p>
<p>Characters at the start or end positions of a match that are ignorable for collation are not included as part of the match, unless they are part of a combining sequence, as described below.</p>
<p>A match will not include a partial combining sequence. Combining character sequences are considered to be inseperable units, and either match the pattern completely, or are considered to not match at all. Thus, for example, an A followed a combining accent mark will not be found when searching for a plain (unaccented) A. (unless the collation strength has been set to ignore all accents).</p>
<p>When beginning a search, the initial starting position, startIdx, is assumed to be an acceptable match boundary with respect to combining characters. A combining sequence that spans across the starting point will not supress a match beginning at startIdx.</p>
<p>Characters that expand to multiple collation elements (German sharp-S becoming 'ss', or the composed forms of accented characters, for example) also must match completely. Searching for a single 's' in a string containing only a sharp-s will find no match.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>the UStringSearch struct, which references both the text to be searched and the pattern being sought. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startIdx</em> </td><td>The index into the text to begin the search. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>matchStart</em> </td><td>An out parameter, the starting index of the matched text. This parameter may be NULL. A value of -1 will be returned if no match was found. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>matchLimit</em> </td><td>Out parameter, the index of the first position following the matched text. The matchLimit will be at a suitable position for beginning a subsequent search in the input text. This parameter may be NULL. A value of -1 will be returned if no match was found.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Report any errors. Note that no match found is not an error. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if a match was found, FALSE otherwise.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000400">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="aafad5d71a67ca39ba1886fbae3659a5b"></a><!-- doxytag: member="usearch.h::usearch_searchBackwards" ref="aafad5d71a67ca39ba1886fbae3659a5b" args="(UStringSearch *strsrch, int32_t startIdx, int32_t *matchStart, int32_t *matchLimit, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> usearch_searchBackwards </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>startIdx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>matchStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>matchLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simple backwards search for the pattern, starting at a specified index, and using using a default set search options. </p>
<p>This is an experimental function, and is not an official part of the ICU API.</p>
<p>The collator options, such as UCOL_STRENGTH and UCOL_NORMALIZTION, are honored.</p>
<p>The UStringSearch options USEARCH_CANONICAL_MATCH, USEARCH_OVERLAP and any Break Iterator are ignored.</p>
<p>Matches obey the following constraints:</p>
<p>Characters at the start or end positions of a match that are ignorable for collation are not included as part of the match, unless they are part of a combining sequence, as described below.</p>
<p>A match will not include a partial combining sequence. Combining character sequences are considered to be inseperable units, and either match the pattern completely, or are considered to not match at all. Thus, for example, an A followed a combining accent mark will not be found when searching for a plain (unaccented) A. (unless the collation strength has been set to ignore all accents).</p>
<p>When beginning a search, the initial starting position, startIdx, is assumed to be an acceptable match boundary with respect to combining characters. A combining sequence that spans across the starting point will not supress a match beginning at startIdx.</p>
<p>Characters that expand to multiple collation elements (German sharp-S becoming 'ss', or the composed forms of accented characters, for example) also must match completely. Searching for a single 's' in a string containing only a sharp-s will find no match.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>the UStringSearch struct, which references both the text to be searched and the pattern being sought. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startIdx</em> </td><td>The index into the text to begin the search. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>matchStart</em> </td><td>An out parameter, the starting index of the matched text. This parameter may be NULL. A value of -1 will be returned if no match was found. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>matchLimit</em> </td><td>Out parameter, the index of the first position following the matched text. The matchLimit will be at a suitable position for beginning a subsequent search in the input text. This parameter may be NULL. A value of -1 will be returned if no match was found.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Report any errors. Note that no match found is not an error. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if a match was found, FALSE otherwise.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000401">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="ac983c4347f0d3d0179d67f0e9ba47bd0"></a><!-- doxytag: member="usearch.h::usearch_setAttribute" ref="ac983c4347f0d3d0179d67f0e9ba47bd0" args="(UStringSearch *strsrch, USearchAttribute attribute, USearchAttributeValue value, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> </td>
<td class="paramname"> <em>attribute</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue. </p>
<p><code>USEARCH_DEFAULT</code> can be used for all attributes for resetting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attribute</em> </td><td>text attribute to be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>text attribute value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#a22948a4f2340979d38e145e13efb7a86" title="Gets the text searching attributes.">usearch_getAttribute</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003853">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a86d42a1e90bb714a38a314d5bb77cda5"></a><!-- doxytag: member="usearch.h::usearch_setBreakIterator" ref="a86d42a1e90bb714a38a314d5bb77cda5" args="(UStringSearch *strsrch, UBreakIterator *breakiter, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setBreakIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ustring_8h.html#adb85bb46d5f93c87098e11deab50bef4">UBreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match will be rejected and another will be searched for. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#a1386c96d1215f380a0678bf368efbbba" title="Returns the BreakIterator that is used to restrict the points at which matches are...">usearch_getBreakIterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003858">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac54be8b9a44d22ec6ea5d53f3cc5d7c5"></a><!-- doxytag: member="usearch.h::usearch_setCollator" ref="ac54be8b9a44d22ec6ea5d53f3cc5d7c5" args="(UStringSearch *strsrch, const UCollator *collator, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setCollator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"> <em>collator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the collator used for the language rules. </p>
<p>User retains the ownership of this collator, thus the responsibility of deletion lies with the user. This method causes internal data such as Boyer-Moore shift tables to be recalculated, but the iterator's position is unchanged. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>collator</em> </td><td>to be used </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003863">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a1291f11a16b4b1090eb7029e4c51c70a"></a><!-- doxytag: member="usearch.h::usearch_setOffset" ref="a1291f11a16b4b1090eb7029e4c51c70a" args="(UStringSearch *strsrch, int32_t position, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the current position in the text string which the next search will start from. </p>
<p>Clears previous states. This method takes the argument index and sets the position in the text string accordingly without checking if the index is pointing to a valid starting point to begin searching. Search positions that may render incorrect results are highlighted in the header comments </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>position to start next search from. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error status if any. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003851">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aa2d53cd40c636eb0da13b891e4a84dbb"></a><!-- doxytag: member="usearch.h::usearch_setPattern" ref="aa2d53cd40c636eb0da13b891e4a84dbb" args="(UStringSearch *strsrch, const UChar *pattern, int32_t patternlength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>patternlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the pattern used for matching. </p>
<p>Internal data like the Boyer Moore table will be recalculated, but the iterator's position is unchanged. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patternlength</em> </td><td>pattern length, -1 for null-terminated string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs. If text is NULL, or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change done to strsrch. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003864">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a09c1c5d4ea8b69ce32993dff6426a386"></a><!-- doxytag: member="usearch.h::usearch_setText" ref="a09c1c5d4ea8b69ce32993dff6426a386" args="(UStringSearch *strsrch, const UChar *text, int32_t textlength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usearch_setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#ab244c09051ecef7e477be6f3e247796d">UStringSearch</a> * </td>
<td class="paramname"> <em>strsrch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>textlength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the string text to be searched. </p>
<p>Text iteration will hence begin at the start of the text string. This method is useful if you want to re-use an iterator to search for the same pattern within a different body of text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strsrch</em> </td><td>search iterator data struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>new string to look for match </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textlength</em> </td><td>length of the new string, -1 for null-termination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs. If text is NULL, or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change done to strsrch. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usearch_8h.html#a4c0acb3936f46b566e39874e6f063f1b" title="Return the string text to be searched.">usearch_getText</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003860">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
764
