doc/html/pcre_exec.html

<html>
<head>
<title>pcre_exec specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_exec man page</h1>
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
<p>
This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
<br>
<br><b>
SYNOPSIS
</b><br>
<P>
<b>#include &#60;pcre.h&#62;</b>
</P>
<P>
<b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
</P>
<br><b>
DESCRIPTION
</b><br>
<P>
This function matches a compiled regular expression against a given subject
string, using a matching algorithm that is similar to Perl's. It returns
offsets to captured substrings. Its arguments are:
<pre>
  <i>code</i>         Points to the compiled pattern
  <i>extra</i>        Points to an associated <b>pcre_extra</b> structure,
                 or is NULL
  <i>subject</i>      Points to the subject string
  <i>length</i>       Length of the subject string, in bytes
  <i>startoffset</i>  Offset in bytes in the subject at which to
                 start matching
  <i>options</i>      Option bits
  <i>ovector</i>      Points to a vector of ints for result offsets
  <i>ovecsize</i>     Number of elements in the vector (a multiple of 3)
</pre>
The options are:
<pre>
  PCRE_ANCHORED      Match only at the first position
  PCRE_NEWLINE_ANY   Recognize any Unicode newline sequence
  PCRE_NEWLINE_CR    Set CR as the newline sequence
  PCRE_NEWLINE_CRLF  Set CRLF as the newline sequence
  PCRE_NEWLINE_LF    Set LF as the newline sequence
  PCRE_NOTBOL        Subject is not the beginning of a line
  PCRE_NOTEOL        Subject is not the end of a line
  PCRE_NOTEMPTY      An empty string is not a valid match
  PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
                       validity (only relevant if PCRE_UTF8
                       was set at compile time)
  PCRE_PARTIAL       Return PCRE_ERROR_PARTIAL for a partial match
</pre>
There are restrictions on what may appear in a pattern when partial matching is
requested. For details, see the
<a href="pcrepartial.html"><b>pcrepartial</b></a>
page.
</P>
<P>
A <b>pcre_extra</b> structure contains the following fields:
<pre>
  <i>flags</i>        Bits indicating which fields are set
  <i>study_data</i>   Opaque data from <b>pcre_study()</b>
  <i>match_limit</i>  Limit on internal resource use
  <i>match_limit_recursion</i>  Limit on internal recursion depth
  <i>callout_data</i> Opaque data passed back to callouts
  <i>tables</i>       Points to character tables or is NULL
</pre>
The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
PCRE_EXTRA_TABLES.
</P>
<P>
There is a complete description of the PCRE native API in the
<a href="pcreapi.html"><b>pcreapi</b></a>
page and a description of the POSIX API in the
<a href="pcreposix.html"><b>pcreposix</b></a>
page.
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
1	nigel	63	<html>
2			<head>
3			<title>pcre_exec specification</title>
4			</head>
5			<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	nigel	75	<h1>pcre_exec man page</h1>
7			<p>
8			Return to the <a href="index.html">PCRE index page</a>.
9			</p>
10			<p>
11			This page is part of the PCRE HTML documentation. It was generated automatically
12			from the original man page. If there is any nonsense in it, please consult the
13			man page, in case the conversion went wrong.
14			<br>
15	nigel	63	<br><b>
16			SYNOPSIS
17			</b><br>
18			<P>
19			<b>#include <pcre.h></b>
20			</P>
21			<P>
22			<b>int pcre_exec(const pcre <i>code</i>, const pcre_extra <i>extra</i>,</b>
23			<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
24			<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
25			</P>
26			<br><b>
27			DESCRIPTION
28			</b><br>
29			<P>
30			This function matches a compiled regular expression against a given subject
31	nigel	77	string, using a matching algorithm that is similar to Perl's. It returns
32			offsets to captured substrings. Its arguments are:
33	nigel	63	<pre>
34			<i>code</i> Points to the compiled pattern
35			<i>extra</i> Points to an associated <b>pcre_extra</b> structure,
36			or is NULL
37			<i>subject</i> Points to the subject string
38			<i>length</i> Length of the subject string, in bytes
39			<i>startoffset</i> Offset in bytes in the subject at which to
40			start matching
41			<i>options</i> Option bits
42			<i>ovector</i> Points to a vector of ints for result offsets
43	nigel	75	<i>ovecsize</i> Number of elements in the vector (a multiple of 3)
44			</pre>
45	nigel	63	The options are:
46			<pre>
47			PCRE_ANCHORED Match only at the first position
48	nigel	93	PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
49	nigel	91	PCRE_NEWLINE_CR Set CR as the newline sequence
50			PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
51			PCRE_NEWLINE_LF Set LF as the newline sequence
52	nigel	63	PCRE_NOTBOL Subject is not the beginning of a line
53			PCRE_NOTEOL Subject is not the end of a line
54			PCRE_NOTEMPTY An empty string is not a valid match
55	nigel	71	PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
56			validity (only relevant if PCRE_UTF8
57			was set at compile time)
58	nigel	75	PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
59			</pre>
60			There are restrictions on what may appear in a pattern when partial matching is
61	nigel	93	requested. For details, see the
62			<a href="pcrepartial.html"><b>pcrepartial</b></a>
63			page.
64	nigel	63	</P>
65			<P>
66	nigel	75	A <b>pcre_extra</b> structure contains the following fields:
67			<pre>
68			<i>flags</i> Bits indicating which fields are set
69			<i>study_data</i> Opaque data from <b>pcre_study()</b>
70	nigel	87	<i>match_limit</i> Limit on internal resource use
71			<i>match_limit_recursion</i> Limit on internal recursion depth
72	nigel	75	<i>callout_data</i> Opaque data passed back to callouts
73			<i>tables</i> Points to character tables or is NULL
74			</pre>
75			The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
76	nigel	87	PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
77			PCRE_EXTRA_TABLES.
78	nigel	75	</P>
79			<P>
80			There is a complete description of the PCRE native API in the
81	nigel	63	<a href="pcreapi.html"><b>pcreapi</b></a>
82	nigel	75	page and a description of the POSIX API in the
83			<a href="pcreposix.html"><b>pcreposix</b></a>
84	nigel	63	page.
85	nigel	75	<p>
86			Return to the <a href="index.html">PCRE index page</a>.
87			</p>
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"