Mercurial Mercurial > oss > FCL > sf > os > fshell / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
libraries/spcre/libpcre/pcre/doc/html/pcreposix.html
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Sat, 31 Jul 2010 19:07:57 +0100
changeset 23 092bcc217d9d
parent 0 7f656887cf89
permissions -rw-r--r--
Tidied iocli exports, build macro tweaks. Removed 4 overloads of CCommandBase::RunCommand[L] that are no longer used at all, and changed one more to not be exported as it's only used internally to iocli.dll. fixed builds on platforms that don't support btrace or any form of tracing.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     1
 
<html>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     2
 
<head>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     3
 
<title>pcreposix specification</title>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     4
 
</head>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     5
 
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     6
 
<h1>pcreposix man page</h1>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     7
 
<p>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     8
 
Return to the <a href="index.html">PCRE index page</a>.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
     9
 
</p>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    10
 
<p>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    11
 
This page is part of the PCRE HTML documentation. It was generated automatically
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    12
 
from the original man page. If there is any nonsense in it, please consult the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    13
 
man page, in case the conversion went wrong.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    14
 
<br>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    15
 
<ul>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    16
 
<li><a name="TOC1" href="#SEC1">SYNOPSIS OF POSIX API</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    17
 
<li><a name="TOC2" href="#SEC2">DESCRIPTION</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    18
 
<li><a name="TOC3" href="#SEC3">COMPILING A PATTERN</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    19
 
<li><a name="TOC4" href="#SEC4">MATCHING NEWLINE CHARACTERS</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    20
 
<li><a name="TOC5" href="#SEC5">MATCHING A PATTERN</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    21
 
<li><a name="TOC6" href="#SEC6">ERROR MESSAGES</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    22
 
<li><a name="TOC7" href="#SEC7">MEMORY USAGE</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    23
 
<li><a name="TOC8" href="#SEC8">AUTHOR</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    24
 
<li><a name="TOC9" href="#SEC9">REVISION</a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    25
 
</ul>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    26
 
<br><a name="SEC1" href="#TOC1">SYNOPSIS OF POSIX API</a><br>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    27
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    28
 
<b>#include &#60;pcreposix.h&#62;</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    29
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    30
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    31
 
<b>int regcomp(regex_t *<i>preg</i>, const char *<i>pattern</i>,</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    32
 
<b>int <i>cflags</i>);</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    33
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    34
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    35
 
<b>int regexec(regex_t *<i>preg</i>, const char *<i>string</i>,</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    36
 
<b>size_t <i>nmatch</i>, regmatch_t <i>pmatch</i>[], int <i>eflags</i>);</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    37
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    38
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    39
 
<b>size_t regerror(int <i>errcode</i>, const regex_t *<i>preg</i>,</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    40
 
<b>char *<i>errbuf</i>, size_t <i>errbuf_size</i>);</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    41
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    42
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    43
 
<b>void regfree(regex_t *<i>preg</i>);</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    44
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    45
 
<br><a name="SEC2" href="#TOC1">DESCRIPTION</a><br>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    46
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    47
 
This set of functions provides a POSIX-style API to the PCRE regular expression
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    48
 
package. See the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    49
 
<a href="pcreapi.html"><b>pcreapi</b></a>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    50
 
documentation for a description of PCRE's native API, which contains much
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    51
 
additional functionality.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    52
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    53
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    54
 
The functions described here are just wrapper functions that ultimately call
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    55
 
the PCRE native API. Their prototypes are defined in the <b>pcreposix.h</b>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    56
 
header file, and on Unix systems the library itself is called
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    57
 
<b>pcreposix.a</b>, so can be accessed by adding <b>-lpcreposix</b> to the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    58
 
command for linking an application that uses them. Because the POSIX functions
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    59
 
call the native ones, it is also necessary to add <b>-lpcre</b>.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    60
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    61
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    62
 
I have implemented only those option bits that can be reasonably mapped to PCRE
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    63
 
native options. In addition, the option REG_EXTENDED is defined with the value
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    64
 
zero. This has no effect, but since programs that are written to the POSIX
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    65
 
interface often use it, this makes it easier to slot in PCRE as a replacement
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    66
 
library. Other POSIX options are not even defined.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    67
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    68
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    69
 
When PCRE is called via these functions, it is only the API that is POSIX-like
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    70
 
in style. The syntax and semantics of the regular expressions themselves are
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    71
 
still those of Perl, subject to the setting of various PCRE options, as
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    72
 
described below. "POSIX-like in style" means that the API approximates to the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    73
 
POSIX definition; it is not fully POSIX-compatible, and in multi-byte encoding
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    74
 
domains it is probably even less compatible.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    75
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    76
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    77
 
The header for these functions is supplied as <b>pcreposix.h</b> to avoid any
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    78
 
potential clash with other POSIX libraries. It can, of course, be renamed or
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    79
 
aliased as <b>regex.h</b>, which is the "correct" name. It provides two
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    80
 
structure types, <i>regex_t</i> for compiled internal forms, and
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    81
 
<i>regmatch_t</i> for returning captured substrings. It also defines some
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    82
 
constants whose names start with "REG_"; these are used for setting options and
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    83
 
identifying error codes.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    84
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    85
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    86
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    87
 
<br><a name="SEC3" href="#TOC1">COMPILING A PATTERN</a><br>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    88
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    89
 
The function <b>regcomp()</b> is called to compile a pattern into an
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    90
 
internal form. The pattern is a C string terminated by a binary zero, and
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    91
 
is passed in the argument <i>pattern</i>. The <i>preg</i> argument is a pointer
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    92
 
to a <b>regex_t</b> structure that is used as a base for storing information
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    93
 
about the compiled regular expression.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    94
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    95
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    96
 
The argument <i>cflags</i> is either zero, or contains one or more of the bits
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    97
 
defined by the following macros:
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    98
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
    99
 
  REG_DOTALL
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   100
 
</pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   101
 
The PCRE_DOTALL option is set when the regular expression is passed for
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   102
 
compilation to the native function. Note that REG_DOTALL is not part of the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   103
 
POSIX standard.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   104
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   105
 
  REG_ICASE
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   106
 
</pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   107
 
The PCRE_CASELESS option is set when the regular expression is passed for
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   108
 
compilation to the native function.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   109
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   110
 
  REG_NEWLINE
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   111
 
</pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   112
 
The PCRE_MULTILINE option is set when the regular expression is passed for
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   113
 
compilation to the native function. Note that this does <i>not</i> mimic the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   114
 
defined POSIX behaviour for REG_NEWLINE (see the following section).
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   115
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   116
 
  REG_NOSUB
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   117
 
</pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   118
 
The PCRE_NO_AUTO_CAPTURE option is set when the regular expression is passed
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   119
 
for compilation to the native function. In addition, when a pattern that is
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   120
 
compiled with this flag is passed to <b>regexec()</b> for matching, the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   121
 
<i>nmatch</i> and <i>pmatch</i> arguments are ignored, and no captured strings
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   122
 
are returned.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   123
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   124
 
  REG_UTF8
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   125
 
</pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   126
 
The PCRE_UTF8 option is set when the regular expression is passed for
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   127
 
compilation to the native function. This causes the pattern itself and all data
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   128
 
strings used for matching it to be treated as UTF-8 strings. Note that REG_UTF8
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   129
 
is not part of the POSIX standard.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   130
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   131
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   132
 
In the absence of these flags, no options are passed to the native function.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   133
 
This means the the regex is compiled with PCRE default semantics. In
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   134
 
particular, the way it handles newline characters in the subject string is the
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   135
 
Perl way, not the POSIX way. Note that setting PCRE_MULTILINE has only
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   136
 
<i>some</i> of the effects specified for REG_NEWLINE. It does not affect the way
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   137
 
newlines are matched by . (they aren't) or by a negative class such as [^a]
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   138
 
(they are).
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   139
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   140
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   141
 
The yield of <b>regcomp()</b> is zero on success, and non-zero otherwise. The
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   142
 
<i>preg</i> structure is filled in on success, and one member of the structure
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   143
 
is public: <i>re_nsub</i> contains the number of capturing subpatterns in
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   144
 
the regular expression. Various error codes are defined in the header file.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   145
 
</P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   146
 
<br><a name="SEC4" href="#TOC1">MATCHING NEWLINE CHARACTERS</a><br>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   147
 
<P>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   148
 
This area is not simple, because POSIX and Perl take different views of things.
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   149
 
It is not possible to get PCRE to obey POSIX semantics, but then PCRE was never
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   150
 
intended to be a POSIX engine. The following table lists the different
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   151
 
possibilities for matching newline characters in PCRE:
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   152
 
<pre>
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   153
 
                          Default   Change with
7f656887cf89 First submission to Symbian Foundation staging server.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset 
   154
 












7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   155


  . matches newline          no     PCRE_DOTALL













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   156


  newline matches [^a]       yes    not changeable













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   157


  $ matches \n at end        yes    PCRE_DOLLARENDONLY













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   158


  $ matches \n in middle     no     PCRE_MULTILINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   159


  ^ matches \n in middle     no     PCRE_MULTILINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   160


</pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   161


This is the equivalent table for POSIX:













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   162


<pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   163


                          Default   Change with













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   164














7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   165


  . matches newline          yes    REG_NEWLINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   166


  newline matches [^a]       yes    REG_NEWLINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   167


  $ matches \n at end        no     REG_NEWLINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   168


  $ matches \n in middle     no     REG_NEWLINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   169


  ^ matches \n in middle     no     REG_NEWLINE













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   170


</pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   171


PCRE's behaviour is the same as Perl's, except that there is no equivalent for













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   172


PCRE_DOLLAR_ENDONLY in Perl. In both PCRE and Perl, there is no way to stop













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   173


newline from matching [^a].













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   174


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   175


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   176


The default POSIX newline handling can be obtained by setting PCRE_DOTALL and













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   177


PCRE_DOLLAR_ENDONLY, but there is no way to make PCRE behave exactly as for the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   178


REG_NEWLINE action.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   179


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   180


<br><a name="SEC5" href="#TOC1">MATCHING A PATTERN</a><br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   181


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   182


The function <b>regexec()</b> is called to match a compiled pattern <i>preg</i>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   183


against a given <i>string</i>, which is by default terminated by a zero byte













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   184


(but see REG_STARTEND below), subject to the options in <i>eflags</i>. These can













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   185


be:













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   186


<pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   187


  REG_NOTBOL













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   188


</pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   189


The PCRE_NOTBOL option is set when calling the underlying PCRE matching













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   190


function.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   191


<pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   192


  REG_NOTEOL













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   193


</pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   194


The PCRE_NOTEOL option is set when calling the underlying PCRE matching













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   195


function.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   196


<pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   197


  REG_STARTEND













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   198


</pre>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   199


The string is considered to start at <i>string</i> + <i>pmatch[0].rm_so</i> and













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   200


to have a terminating NUL located at <i>string</i> + <i>pmatch[0].rm_eo</i>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   201


(there need not actually be a NUL at that location), regardless of the value of













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   202


<i>nmatch</i>. This is a BSD extension, compatible with but not specified by













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   203


IEEE Standard 1003.2 (POSIX.2), and should be used with caution in software













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   204


intended to be portable to other systems. Note that a non-zero <i>rm_so</i> does













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   205


not imply REG_NOTBOL; REG_STARTEND affects only the location of the string, not













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   206


how it is matched.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   207


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   208


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   209


If the pattern was compiled with the REG_NOSUB flag, no data about any matched













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   210


strings is returned. The <i>nmatch</i> and <i>pmatch</i> arguments of













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   211


<b>regexec()</b> are ignored.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   212


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   213


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   214


Otherwise,the portion of the string that was matched, and also any captured













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   215


substrings, are returned via the <i>pmatch</i> argument, which points to an













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   216


array of <i>nmatch</i> structures of type <i>regmatch_t</i>, containing the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   217


members <i>rm_so</i> and <i>rm_eo</i>. These contain the offset to the first













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   218


character of each substring and the offset to the first character after the end













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   219


of each substring, respectively. The 0th element of the vector relates to the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   220


entire portion of <i>string</i> that was matched; subsequent elements relate to













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   221


the capturing subpatterns of the regular expression. Unused entries in the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   222


array have both structure members set to -1.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   223


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   224


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   225


A successful match yields a zero return; various error codes are defined in the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   226


header file, of which REG_NOMATCH is the "expected" failure code.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   227


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   228


<br><a name="SEC6" href="#TOC1">ERROR MESSAGES</a><br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   229


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   230


The <b>regerror()</b> function maps a non-zero errorcode from either













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   231


<b>regcomp()</b> or <b>regexec()</b> to a printable message. If <i>preg</i> is not













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   232


NULL, the error should have arisen from the use of that structure. A message













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   233


terminated by a binary zero is placed in <i>errbuf</i>. The length of the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   234


message, including the zero, is limited to <i>errbuf_size</i>. The yield of the













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   235


function is the size of buffer needed to hold the whole message.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   236


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   237


<br><a name="SEC7" href="#TOC1">MEMORY USAGE</a><br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   238


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   239


Compiling a regular expression causes memory to be allocated and associated













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   240


with the <i>preg</i> structure. The function <b>regfree()</b> frees all such













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   241


memory, after which <i>preg</i> may no longer be used as a compiled expression.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   242


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   243


<br><a name="SEC8" href="#TOC1">AUTHOR</a><br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   244


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   245


Philip Hazel













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   246


<br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   247


University Computing Service













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   248


<br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   249


Cambridge CB2 3QH, England.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   250


<br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   251


</P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   252


<br><a name="SEC9" href="#TOC1">REVISION</a><br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   253


<P>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   254


Last updated: 05 April 2008













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   255


<br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   256


Copyright &copy; 1997-2008 University of Cambridge.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   257


<br>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   258


<p>













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   259


Return to the <a href="index.html">PCRE index page</a>.













7f656887cf89
First submission to Symbian Foundation staging server.



Tom Sutcliffe <thomas.sutcliffe@accenture.com>


parents: 

diff
changeset




   260


</p>















FCL/sf/os/fshell