<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: uregex.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>uregex.h File Reference</h1>C API: Regular Expressions. <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="parseerr_8h-source.html">unicode/parseerr.h</a>"</code><br>
<p>
<a href="uregex_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure represeting a compiled regular rexpression, plus the results of a match operation. <a href="#566882c83d9e4dcf7fb5d8f859625500"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae">URegexpFlag</a> { <br>
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae95ee02c73b45843f44d316c913826b79">UREGEX_CANON_EQ</a> = 128,
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae909d2ed2c61e34cb62dc13e29f6923ec">UREGEX_CASE_INSENSITIVE</a> = 2,
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae2f3e059e7b90f4bc9574740e89a7b0f1">UREGEX_COMMENTS</a> = 4,
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae0220d4e90a67e1cdd6c1c02ecc8189f3">UREGEX_DOTALL</a> = 32,
<br>
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae5955d9b9e4cdfcd1fccafde751f02488">UREGEX_MULTILINE</a> = 8,
<a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529aee1499468a7aa6f7b2059b7839c6003dd">UREGEX_UWORD</a> = 256
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constants for Regular Expression Match Modes. <a href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#31fa9daa487155dfa8e60dbfbf9472e7">uregex_open</a> (const UChar *pattern, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> patternLength, <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> flags, <a class="el" href="structUParseError.html">UParseError</a> *pe, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open (compile) an ICU regular expression. <a href="#31fa9daa487155dfa8e60dbfbf9472e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#e44e4d2f7ec00fa790a82c5ee47b6296">uregex_openC</a> (const char *pattern, <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> flags, <a class="el" href="structUParseError.html">UParseError</a> *pe, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open (compile) an ICU regular expression. <a href="#e44e4d2f7ec00fa790a82c5ee47b6296"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#7fdfb34cdda683226599e95b388c5575">uregex_close</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the regular expression, recovering all resources (memory) it was holding. <a href="#7fdfb34cdda683226599e95b388c5575"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#3befb11b7c9b28c19af6114ed19b7339">uregex_clone</a> (const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a copy of a compiled regular expression. <a href="#3befb11b7c9b28c19af6114ed19b7339"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const UChar * </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#8b1ee386c236bee2df00020117a6cf42">uregex_pattern</a> (const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *patLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the source form of the pattern for this regular expression. <a href="#8b1ee386c236bee2df00020117a6cf42"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#eb4d05c6038bcd4b8320db9981793ff9">uregex_flags</a> (const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the match mode flags that were specified when compiling this regular expression. <a href="#eb4d05c6038bcd4b8320db9981793ff9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#49855db9ac7b4ecf5f4cf10d3d71d170">uregex_setText</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, const UChar *text, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> textLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the subject text string upon which the regular expression will look for matches. <a href="#49855db9ac7b4ecf5f4cf10d3d71d170"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const UChar * </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#78cec27fd3e8238c5a9c08ae66884c80">uregex_getText</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *textLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the subject text that is currently associated with this regular expression object. <a href="#78cec27fd3e8238c5a9c08ae66884c80"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#6f8a6e557083831cbd8111fdd5b562ce">uregex_matches</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> startIndex, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to match the input string, beginning at startIndex, against the pattern. <a href="#6f8a6e557083831cbd8111fdd5b562ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#52c90b073f572a7dd1052c7785a81b79">uregex_lookingAt</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> startIndex, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to match the input string, starting from the specified index, against the pattern. <a href="#52c90b073f572a7dd1052c7785a81b79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#74e00aa35711875aab88fd550de6b1d6">uregex_find</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> startIndex, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the first matching substring of the input string that matches the pattern. <a href="#74e00aa35711875aab88fd550de6b1d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#a173870af2e8d79a06faea5e334bd5f9">uregex_findNext</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the next pattern match in the input string. <a href="#a173870af2e8d79a06faea5e334bd5f9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#d6ff01458e9d10ad9a66c980e9c1dfd8">uregex_groupCount</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of capturing groups in this regular expression's pattern. <a href="#d6ff01458e9d10ad9a66c980e9c1dfd8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#b4dfb358ba585dbf56e195a704874d93">uregex_group</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> groupNum, UChar *dest, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the string for the specified matching expression or subexpression. <a href="#b4dfb358ba585dbf56e195a704874d93"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#5a2eccd52a16efe1ba99c53d56614a4f">uregex_start</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> groupNum, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index in the input string of the start of the text matched by the specified capture group during the previous match operation. <a href="#5a2eccd52a16efe1ba99c53d56614a4f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#3f5e9eba75d943ff1aba3d3dc779a67f">uregex_end</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> groupNum, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index in the input string of the position following the end of the text matched by the specified capture group. <a href="#3f5e9eba75d943ff1aba3d3dc779a67f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#32b5a1a76b9eb313d5093290d19245db">uregex_reset</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> index, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset any saved state from the previous match. <a href="#32b5a1a76b9eb313d5093290d19245db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#46252f42e1d2376af1927bf9b67cd530">uregex_replaceAll</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, const UChar *replacementText, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> replacementLength, UChar *destBuf, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces every substring of the input that matches the pattern with the given replacement string. <a href="#46252f42e1d2376af1927bf9b67cd530"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#1d5bc74b5e00b183ad20e06927d72e9e">uregex_replaceFirst</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, const UChar *replacementText, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> replacementLength, UChar *destBuf, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces the first substring of the input that matches the pattern with the given replacement string. <a href="#1d5bc74b5e00b183ad20e06927d72e9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#4855f7a0ee316669a299dc9f7e8bace5">uregex_appendReplacement</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, const UChar *replacementText, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> replacementLength, UChar **destBuf, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *destCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implements a replace operation intended to be used as part of an incremental find-and-replace. <a href="#4855f7a0ee316669a299dc9f7e8bace5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#40cb404e6bfb8f8bf2d2640f60c5d2cf">uregex_appendTail</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, UChar **destBuf, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *destCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">As the final step in a find-and-replace operation, append the remainder of the input string, starting at the position following the last match, to the destination string. <a href="#40cb404e6bfb8f8bf2d2640f60c5d2cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uregex_8h.html#2a7440d07f6c8692d30a3e090494d2d1">uregex_split</a> (<a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> *regexp, UChar *destBuf, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destCapacity, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *requiredCapacity, UChar *destFields[], <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> destFieldsCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Split a string into fields. <a href="#2a7440d07f6c8692d30a3e090494d2d1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C API: Regular Expressions.
<p>
This is a C wrapper around the C++ <a class="el" href="classRegexPattern.html">RegexPattern</a> and <a class="el" href="classRegexMatcher.html">RegexMatcher</a> classes.
<p>
Definition in file <a class="el" href="uregex_8h-source.html">uregex.h</a>.<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="566882c83d9e4dcf7fb5d8f859625500"></a><!-- doxytag: member="uregex.h::URegularExpression" ref="566882c83d9e4dcf7fb5d8f859625500" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Structure represeting a compiled regular rexpression, plus the results of a match operation.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003220">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>
Definition at line <a class="el" href="uregex_8h-source.html#l00038">38</a> of file <a class="el" href="uregex_8h-source.html">uregex.h</a>.
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae"></a><!-- doxytag: member="uregex.h::URegexpFlag" ref="874989dfec4cbeb6baf4d1a51cb529ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae">URegexpFlag</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constants for Regular Expression Match Modes.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003221">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae95ee02c73b45843f44d316c913826b79"></a><!-- doxytag: member="UREGEX_CANON_EQ" ref="874989dfec4cbeb6baf4d1a51cb529ae95ee02c73b45843f44d316c913826b79" args="" -->UREGEX_CANON_EQ</em> </td><td>
Forces normalization of pattern and strings.
<p>
Not implemented yet, just a placeholder, hence draft. <dl compact><dt><b><a class="el" href="draft.html#_draft000254">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 2.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae909d2ed2c61e34cb62dc13e29f6923ec"></a><!-- doxytag: member="UREGEX_CASE_INSENSITIVE" ref="874989dfec4cbeb6baf4d1a51cb529ae909d2ed2c61e34cb62dc13e29f6923ec" args="" -->UREGEX_CASE_INSENSITIVE</em> </td><td>
Enable case insensitive matching.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003244">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae2f3e059e7b90f4bc9574740e89a7b0f1"></a><!-- doxytag: member="UREGEX_COMMENTS" ref="874989dfec4cbeb6baf4d1a51cb529ae2f3e059e7b90f4bc9574740e89a7b0f1" args="" -->UREGEX_COMMENTS</em> </td><td>
Allow white space and comments within patterns.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003245">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae0220d4e90a67e1cdd6c1c02ecc8189f3"></a><!-- doxytag: member="UREGEX_DOTALL" ref="874989dfec4cbeb6baf4d1a51cb529ae0220d4e90a67e1cdd6c1c02ecc8189f3" args="" -->UREGEX_DOTALL</em> </td><td>
If set, '.
<p>
' matches line terminators, otherwise '.' matching stops at line end. <dl compact><dt><b><a class="el" href="stable.html#_stable003246">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529ae5955d9b9e4cdfcd1fccafde751f02488"></a><!-- doxytag: member="UREGEX_MULTILINE" ref="874989dfec4cbeb6baf4d1a51cb529ae5955d9b9e4cdfcd1fccafde751f02488" args="" -->UREGEX_MULTILINE</em> </td><td>
Control behavior of "$" and "^" If set, recognize line terminators within string, otherwise, match only at start and end of input string.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003247">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="874989dfec4cbeb6baf4d1a51cb529aee1499468a7aa6f7b2059b7839c6003dd"></a><!-- doxytag: member="UREGEX_UWORD" ref="874989dfec4cbeb6baf4d1a51cb529aee1499468a7aa6f7b2059b7839c6003dd" args="" -->UREGEX_UWORD</em> </td><td>
Unicode word boundaries.
<p>
If set, <b>uses</b> the Unicode TR 29 definition of word boundaries. Warning: Unicode word boundaries are quite different from traditional regular expression word boundaries. See <a href="http://unicode.org/reports/tr29/#Word_Boundaries">http://unicode.org/reports/tr29/#Word_Boundaries</a> <dl compact><dt><b><a class="el" href="stable.html#_stable003248">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="uregex_8h-source.html#l00045">45</a> of file <a class="el" href="uregex_8h-source.html">uregex.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="4855f7a0ee316669a299dc9f7e8bace5"></a><!-- doxytag: member="uregex.h::uregex_appendReplacement" ref="4855f7a0ee316669a299dc9f7e8bace5" args="(URegularExpression *regexp, const UChar *replacementText, int32_t replacementLength, UChar **destBuf, int32_t *destCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_appendReplacement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>replacementText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>replacementLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar ** </td>
<td class="paramname"> <em>destBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implements a replace operation intended to be used as part of an incremental find-and-replace.
<p>
The input string, starting from the end of the previous match and ending at the start of the current match, is appended to the destination string. Then the replacement string is appended to the output string, including handling any substitutions of captured text.<p>
A note on preflight computation of buffersize and error handling: Calls to <a class="el" href="uregex_8h.html#4855f7a0ee316669a299dc9f7e8bace5">uregex_appendReplacement()</a> and <a class="el" href="uregex_8h.html#40cb404e6bfb8f8bf2d2640f60c5d2cf">uregex_appendTail()</a> are designed to be chained, one after another, with the destination buffer pointer and buffer capacity updated after each in preparation to for the next. If the destination buffer is exhausted partway through such a sequence, a U_BUFFER_OVERFLOW_ERROR status will be returned. Normal ICU conventions are for a function to perform no action if it is called with an error status, but for this one case, uregex_appendRepacement() will operate normally so that buffer size computations will complete correctly.<p>
For simple, prepackaged, non-incremental find-and-replace operations, see replaceFirst() or replaceAll().<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The regular expression object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementText</em> </td><td>The string that will replace the matched portion of the input string as it is copied to the destination buffer. The replacement text may contain references ($1, for example) to capture groups from the match. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementLength</em> </td><td>The length of the replacement text string, or -1 if the string is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destBuf</em> </td><td>The buffer into which the results of the find-and-replace are placed. On return, this pointer will be updated to refer to the beginning of the unused portion of buffer, leaving it in position for a subsequent call to this function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the output buffer, On return, this parameter will be updated to reflect the space remaining unused in the output buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string. In the event that destCapacity is inadequate, the full length of the untruncated output string is returned.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003241">Stable:</a></b></dt><dd>ICU 3.0</dd></dl>
</div>
</div><p>
<a class="anchor" name="40cb404e6bfb8f8bf2d2640f60c5d2cf"></a><!-- doxytag: member="uregex.h::uregex_appendTail" ref="40cb404e6bfb8f8bf2d2640f60c5d2cf" args="(URegularExpression *regexp, UChar **destBuf, int32_t *destCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_appendTail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar ** </td>
<td class="paramname"> <em>destBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
As the final step in a find-and-replace operation, append the remainder of the input string, starting at the position following the last match, to the destination string.
<p>
<code><a class="el" href="uregex_8h.html#40cb404e6bfb8f8bf2d2640f60c5d2cf">uregex_appendTail()</a></code> is intended to be invoked after one or more invocations of the <code><a class="el" href="uregex_8h.html#4855f7a0ee316669a299dc9f7e8bace5">uregex_appendReplacement()</a></code> function.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The regular expression object. This is needed to obtain the input string and with the position of the last match within it. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destBuf</em> </td><td>The buffer in which the results of the find-and-replace are placed. On return, the pointer will be updated to refer to the beginning of the unused portion of buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The size of the output buffer, On return, this value will be updated to reflect the space remaining unused in the output buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the result string. In the event that destCapacity is inadequate, the full length of the untruncated output string is returned.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003242">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3befb11b7c9b28c19af6114ed19b7339"></a><!-- doxytag: member="uregex.h::uregex_clone" ref="3befb11b7c9b28c19af6114ed19b7339" args="(const URegularExpression *regexp, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a>* uregex_clone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Make a copy of a compiled regular expression.
<p>
Cloning a regular expression is faster than opening a second instance from the source form of the expression, and requires less memory. <p>
Note that the current input string and the position of any matched text within it are not cloned; only the pattern itself and and the match mode flags are copied. <p>
Cloning can be particularly useful to threaded applications that perform multiple match operations in parallel. Each concurrent RE operation requires its own instance of a URegularExpression.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression to be cloned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives indication of any errors encountered </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the cloned copy of the compiled regular expression. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003225">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7fdfb34cdda683226599e95b388c5575"></a><!-- doxytag: member="uregex.h::uregex_close" ref="7fdfb34cdda683226599e95b388c5575" args="(URegularExpression *regexp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uregex_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the regular expression, recovering all resources (memory) it was holding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The regular expression to be closed. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003224">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3f5e9eba75d943ff1aba3d3dc779a67f"></a><!-- doxytag: member="uregex.h::uregex_end" ref="3f5e9eba75d943ff1aba3d3dc779a67f" args="(URegularExpression *regexp, int32_t groupNum, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_end </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>groupNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the index in the input string of the position following the end of the text matched by the specified capture group.
<p>
Return -1 if the capture group was not part of the last match. Group #0 refers to the complete range of matched text. Group #1 refers to the text matched by the first set of capturing parentheses.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>groupNum</em> </td><td>The capture group number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the index of the position following the last matched character. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003237">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="74e00aa35711875aab88fd550de6b1d6"></a><!-- doxytag: member="uregex.h::uregex_find" ref="74e00aa35711875aab88fd550de6b1d6" args="(URegularExpression *regexp, int32_t startIndex, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> uregex_find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>startIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find the first matching substring of the input string that matches the pattern.
<p>
The search for a match begins at the specified index. If a match is found, <code><a class="el" href="uregex_8h.html#5a2eccd52a16efe1ba99c53d56614a4f">uregex_start()</a>, <a class="el" href="uregex_8h.html#3f5e9eba75d943ff1aba3d3dc779a67f">uregex_end()</a></code>, and <code><a class="el" href="uregex_8h.html#b4dfb358ba585dbf56e195a704874d93">uregex_group()</a></code> will provide more information regarding the match.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startIndex</em> </td><td>The position in the input string to begin the search </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if a match is found. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003232">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a173870af2e8d79a06faea5e334bd5f9"></a><!-- doxytag: member="uregex.h::uregex_findNext" ref="a173870af2e8d79a06faea5e334bd5f9" args="(URegularExpression *regexp, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> uregex_findNext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find the next pattern match in the input string.
<p>
Begin searching the input at the location following the end of the previous match, or at the start of the string if there is no previous match. If a match is found, <code><a class="el" href="uregex_8h.html#5a2eccd52a16efe1ba99c53d56614a4f">uregex_start()</a>, <a class="el" href="uregex_8h.html#3f5e9eba75d943ff1aba3d3dc779a67f">uregex_end()</a></code>, and <code><a class="el" href="uregex_8h.html#b4dfb358ba585dbf56e195a704874d93">uregex_group()</a></code> will provide more information regarding the match.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if a match is found. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uregex_8h.html#32b5a1a76b9eb313d5093290d19245db">uregex_reset</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003233">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="eb4d05c6038bcd4b8320db9981793ff9"></a><!-- doxytag: member="uregex.h::uregex_flags" ref="eb4d05c6038bcd4b8320db9981793ff9" args="(const URegularExpression *regexp, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_flags </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the match mode flags that were specified when compiling this regular expression.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The match mode flags </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uregex_8h.html#874989dfec4cbeb6baf4d1a51cb529ae">URegexpFlag</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003227">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="78cec27fd3e8238c5a9c08ae66884c80"></a><!-- doxytag: member="uregex.h::uregex_getText" ref="78cec27fd3e8238c5a9c08ae66884c80" args="(URegularExpression *regexp, int32_t *textLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const UChar* uregex_getText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"> <em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the subject text that is currently associated with this regular expression object.
<p>
This simply returns whatever string pointer was previously supplied via <a class="el" href="uregex_8h.html#49855db9ac7b4ecf5f4cf10d3d71d170">uregex_setText()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLength</em> </td><td>The length of the string is returned in this output parameter. A NULL pointer may be used here if the text length is not needed, as would be the case if the text is known in advance to be a NUL terminated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Poiner to the subject text string currently associated with this regular expression. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003229">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b4dfb358ba585dbf56e195a704874d93"></a><!-- doxytag: member="uregex.h::uregex_group" ref="b4dfb358ba585dbf56e195a704874d93" args="(URegularExpression *regexp, int32_t groupNum, UChar *dest, int32_t destCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_group </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>groupNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extract the string for the specified matching expression or subexpression.
<p>
Group #0 is the complete string of matched text. Group #1 is the text matched by the first set of capturing parentheses.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>groupNum</em> </td><td>The capture group to extract. Group 0 is the complete match. The value of this parameter must be less than or equal to the number of capture groups in the pattern. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Buffer to receive the matching string data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>Capacity of the dest buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Length of matching data, or -1 if no applicable match. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003235">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d6ff01458e9d10ad9a66c980e9c1dfd8"></a><!-- doxytag: member="uregex.h::uregex_groupCount" ref="d6ff01458e9d10ad9a66c980e9c1dfd8" args="(URegularExpression *regexp, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_groupCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of capturing groups in this regular expression's pattern.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of capture groups </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003234">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="52c90b073f572a7dd1052c7785a81b79"></a><!-- doxytag: member="uregex.h::uregex_lookingAt" ref="52c90b073f572a7dd1052c7785a81b79" args="(URegularExpression *regexp, int32_t startIndex, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> uregex_lookingAt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>startIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempts to match the input string, starting from the specified index, against the pattern.
<p>
The match may be of any length, and is not required to extend to the end of the input string. Contrast with <a class="el" href="uregex_8h.html#6f8a6e557083831cbd8111fdd5b562ce">uregex_matches()</a>.<p>
If the match succeeds then more information can be obtained via the <code>uregexp_start()</code>, <code>uregexp_end()</code>, and <code>uregexp_group()</code> functions.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startIndex</em> </td><td>The input string index at which to begin matching. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if there is a match. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003231">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="6f8a6e557083831cbd8111fdd5b562ce"></a><!-- doxytag: member="uregex.h::uregex_matches" ref="6f8a6e557083831cbd8111fdd5b562ce" args="(URegularExpression *regexp, int32_t startIndex, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> uregex_matches </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>startIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempts to match the input string, beginning at startIndex, against the pattern.
<p>
To succeed, the match must extend to the end of the input string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startIndex</em> </td><td>The input string index at which to begin matching. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if there is a match </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003230">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="31fa9daa487155dfa8e60dbfbf9472e7"></a><!-- doxytag: member="uregex.h::uregex_open" ref="31fa9daa487155dfa8e60dbfbf9472e7" args="(const UChar *pattern, int32_t patternLength, uint32_t flags, UParseError *pe, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a>* uregex_open </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>patternLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"> <em>pe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open (compile) an ICU regular expression.
<p>
Compiles the regular expression in string form into an internal representation using the specified match mode flags. The resulting regular expression handle can then be used to perform various matching operations.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>The Regular Expression pattern to be compiled. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patternLength</em> </td><td>The length of the pattern, or -1 if the pattern is NUL termintated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flags that alter the default matching behavior for the regular expression, UREGEX_CASE_INSENSITIVE, for example. For default behavior, set this parameter to zero. See <code>enum URegexpFlag</code>. All desired flags are bitwise-ORed together. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pe</em> </td><td>Receives the position (line and column nubers) of any syntax error within the source regular expression string. If this information is not wanted, pass NULL for this parameter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives error detected by this function. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003222">Stable:</a></b></dt><dd>ICU 3.0</dd></dl>
</div>
</div><p>
<a class="anchor" name="e44e4d2f7ec00fa790a82c5ee47b6296"></a><!-- doxytag: member="uregex.h::uregex_openC" ref="e44e4d2f7ec00fa790a82c5ee47b6296" args="(const char *pattern, uint32_t flags, UParseError *pe, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a>* uregex_openC </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"> <em>pe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open (compile) an ICU regular expression.
<p>
The resulting regular expression handle can then be used to perform various matching operations. <p>
This function is the same as uregex_open, except that the pattern is supplied as an 8 bit char * string in the default code page.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>The Regular Expression pattern to be compiled, NUL termintated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flags that alter the default matching behavior for the regular expression, UREGEX_CASE_INSENSITIVE, for example. For default behavior, set this parameter to zero. See <code>enum URegexpFlag</code>. All desired flags are bitwise-ORed together. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pe</em> </td><td>Receives the position (line and column nubers) of any syntax error within the source regular expression string. If this information is not wanted, pass NULL for this parameter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The URegularExpression object representing the compiled pattern.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003223">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b1ee386c236bee2df00020117a6cf42"></a><!-- doxytag: member="uregex.h::uregex_pattern" ref="8b1ee386c236bee2df00020117a6cf42" args="(const URegularExpression *regexp, int32_t *patLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const UChar* uregex_pattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"> <em>patLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a pointer to the source form of the pattern for this regular expression.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patLength</em> </td><td>This output parameter will be set to the length of the pattern string. A NULL pointer may be used here if the pattern length is not needed, as would be the case if the pattern is known in advance to be a NUL terminated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to the pattern string. The storage for the string is owned by the regular expression object, and must not be altered or deleted by the application. The returned string will remain valid until the regular expression is closed. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003226">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="46252f42e1d2376af1927bf9b67cd530"></a><!-- doxytag: member="uregex.h::uregex_replaceAll" ref="46252f42e1d2376af1927bf9b67cd530" args="(URegularExpression *regexp, const UChar *replacementText, int32_t replacementLength, UChar *destBuf, int32_t destCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_replaceAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>replacementText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>replacementLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>destBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Replaces every substring of the input that matches the pattern with the given replacement string.
<p>
This is a convenience function that provides a complete find-and-replace-all operation.<p>
This method scans the input string looking for matches of the pattern. Input that is not part of any match is copied unchanged to the destination buffer. Matched regions are replaced in the output buffer by the replacement string. The replacement string may contain references to capture groups; these take the form of $1, $2, etc.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementText</em> </td><td>A string containing the replacement text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementLength</em> </td><td>The length of the replacement string, or -1 if it is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destBuf</em> </td><td>A (UChar *) buffer that will receive the result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The capacity of the desitnation buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the string resulting from the find and replace operation. In the event that the destination capacity is inadequate, the return value is still the full length of the untruncated string. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003239">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1d5bc74b5e00b183ad20e06927d72e9e"></a><!-- doxytag: member="uregex.h::uregex_replaceFirst" ref="1d5bc74b5e00b183ad20e06927d72e9e" args="(URegularExpression *regexp, const UChar *replacementText, int32_t replacementLength, UChar *destBuf, int32_t destCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_replaceFirst </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>replacementText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>replacementLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>destBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Replaces the first substring of the input that matches the pattern with the given replacement string.
<p>
This is a convenience function that provides a complete find-and-replace operation.<p>
This method scans the input string looking for a match of the pattern. All input that is not part of the match is copied unchanged to the destination buffer. The matched region is replaced in the output buffer by the replacement string. The replacement string may contain references to capture groups; these take the form of $1, $2, etc.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementText</em> </td><td>A string containing the replacement text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacementLength</em> </td><td>The length of the replacement string, or -1 if it is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destBuf</em> </td><td>A (UChar *) buffer that will receive the result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The capacity of the desitnation buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>a reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the string resulting from the find and replace operation. In the event that the destination capacity is inadequate, the return value is still the full length of the untruncated string. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003240">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="32b5a1a76b9eb313d5093290d19245db"></a><!-- doxytag: member="uregex.h::uregex_reset" ref="32b5a1a76b9eb313d5093290d19245db" args="(URegularExpression *regexp, int32_t index, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uregex_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset any saved state from the previous match.
<p>
Has the effect of causing uregex_findNext to begin at the specified index, and causing <a class="el" href="uregex_8h.html#5a2eccd52a16efe1ba99c53d56614a4f">uregex_start()</a>, <a class="el" href="uregex_8h.html#3f5e9eba75d943ff1aba3d3dc779a67f">uregex_end()</a> and <a class="el" href="uregex_8h.html#b4dfb358ba585dbf56e195a704874d93">uregex_group()</a> to return an error indicating that there is no match information available.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The position in the text at which a <a class="el" href="uregex_8h.html#a173870af2e8d79a06faea5e334bd5f9">uregex_findNext()</a> should begin searching. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003238">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="49855db9ac7b4ecf5f4cf10d3d71d170"></a><!-- doxytag: member="uregex.h::uregex_setText" ref="49855db9ac7b4ecf5f4cf10d3d71d170" args="(URegularExpression *regexp, const UChar *text, int32_t textLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uregex_setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the subject text string upon which the regular expression will look for matches.
<p>
This function may be called any number of times, allowing the regular expression pattern to be applied to different strings. <p>
Regular expression matching operations work directly on the application's string data. No copy is made. The subject string data must not be altered after calling this function until after all regular expression operations involving this string data are completed. <p>
Zero length strings are permitted. In this case, no subsequent match operation will dereference the text string pointer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The subject text string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLength</em> </td><td>The length of the subject text, or -1 if the string is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Receives errors detected by this function. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003228">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2a7440d07f6c8692d30a3e090494d2d1"></a><!-- doxytag: member="uregex.h::uregex_split" ref="2a7440d07f6c8692d30a3e090494d2d1" args="(URegularExpression *regexp, UChar *destBuf, int32_t destCapacity, int32_t *requiredCapacity, UChar *destFields[], int32_t destFieldsCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_split </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>destBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"> <em>requiredCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>destFields</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>destFieldsCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Split a string into fields.
<p>
Somewhat like split() from Perl. The pattern matches identify delimiters that separate the input into fields. The input data between the matches becomes the fields themselves. <p>
Each of the fields is copied from the input string to the destination buffer, and the NUL terminated. The position of each field within the destination buffer is returned in the destFields array.<p>
Note: another choice for the design of this function would be to not copy the resulting fields at all, but to return indexes and lengths within the source text. Advantages would be o Faster. No Copying. o Nothing extra needed when field data may contain embedded NUL chars. o Less memory needed if working on large data. Disadvantages o Less consistent with C++ split, which copies into an array of UnicodeStrings. o No NUL termination, extracted fields would be less convenient to use in most cases. o Possible problems in the future, when support Unicode Normalization could cause the fields to not correspond exactly to a range of the source text.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destBuf</em> </td><td>A (UChar *) buffer to receive the fields that are extracted from the input string. These field pointers will refer to positions within the destination buffer supplied by the caller. Any extra positions within the destFields array will be set to NULL. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destCapacity</em> </td><td>The capacity of the destBuf. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>requiredCapacity</em> </td><td>The actual capacity required of the destBuf. If destCapacity is too small, requiredCapacity will return the total capacity required to hold all of the output, and a U_BUFFER_OVERFLOW_ERROR will be returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destFields</em> </td><td>An array to be filled with the position of each of the extracted fields within destBuf. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destFieldsCapacity</em> </td><td>The number of elements in the destFields array. If the number of fields found is less than destFieldsCapacity, the extra destFields elements are set to zero. If destFieldsCapacity is too small, the trailing part of the input, including any field delimiters, is treated as if it were the last field - it is copied to the destBuf, and its position is in the destBuf is stored in the last element of destFields. This behavior mimics that of Perl. It is not an error condition, and no error status is returned when all destField positions are used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of fields into which the input string was split. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003243">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="5a2eccd52a16efe1ba99c53d56614a4f"></a><!-- doxytag: member="uregex.h::uregex_start" ref="5a2eccd52a16efe1ba99c53d56614a4f" args="(URegularExpression *regexp, int32_t groupNum, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> uregex_start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregex_8h.html#566882c83d9e4dcf7fb5d8f859625500">URegularExpression</a> * </td>
<td class="paramname"> <em>regexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>groupNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the index in the input string of the start of the text matched by the specified capture group during the previous match operation.
<p>
Return -1 if the capture group was not part of the last match. Group #0 refers to the complete range of matched text. Group #1 refers to the text matched by the first set of capturing parentheses.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>regexp</em> </td><td>The compiled regular expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>groupNum</em> </td><td>The capture group number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>A reference to a UErrorCode to receive any errors. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the starting position in the input of the text matched by the specified group. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003236">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:29 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
280da2a01a3d16776505ea3f476de84f
>
files
>
472
