/[pcre]/code/trunk/doc/html/pcre_exec.html
ViewVC logotype

Diff of /code/trunk/doc/html/pcre_exec.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 150 by ph10, Tue Apr 17 08:22:40 2007 UTC
# Line 3  Line 3 
3  <title>pcre_exec specification</title>  <title>pcre_exec specification</title>
4  </head>  </head>
5  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6  This HTML document has been generated automatically from the original man page.  <h1>pcre_exec man page</h1>
7  If there is any nonsense in it, please consult the man page, in case the  <p>
8  conversion went wrong.<br>  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  <br><b>  <br><b>
16  SYNOPSIS  SYNOPSIS
17  </b><br>  </b><br>
# Line 22  DESCRIPTION Line 28  DESCRIPTION
28  </b><br>  </b><br>
29  <P>  <P>
30  This function matches a compiled regular expression against a given subject  This function matches a compiled regular expression against a given subject
31  string, and returns offsets to capturing subexpressions. Its arguments are:  string, using a matching algorithm that is similar to Perl's. It returns
32  </P>  offsets to captured substrings. Its arguments are:
 <P>  
33  <pre>  <pre>
34    <i>code</i>         Points to the compiled pattern    <i>code</i>         Points to the compiled pattern
35    <i>extra</i>        Points to an associated <b>pcre_extra</b> structure,    <i>extra</i>        Points to an associated <b>pcre_extra</b> structure,
# Line 35  string, and returns offsets to capturing Line 40  string, and returns offsets to capturing
40                   start matching                   start matching
41    <i>options</i>      Option bits    <i>options</i>      Option bits
42    <i>ovector</i>      Points to a vector of ints for result offsets    <i>ovector</i>      Points to a vector of ints for result offsets
43    <i>ovecsize</i>     Size of the vector (a multiple of 3)    <i>ovecsize</i>     Number of elements in the vector (a multiple of 3)
44  </PRE>  </pre>
 </P>  
 <P>  
45  The options are:  The options are:
 </P>  
 <P>  
46  <pre>  <pre>
47    PCRE_ANCHORED      Match only at the first position    PCRE_ANCHORED      Match only at the first position
48      PCRE_NEWLINE_ANY   Recognize any Unicode newline sequence
49      PCRE_NEWLINE_ANYCRLF  Recognize CR, LF, and CRLF as newline sequences
50      PCRE_NEWLINE_CR    Set CR as the newline sequence
51      PCRE_NEWLINE_CRLF  Set CRLF as the newline sequence
52      PCRE_NEWLINE_LF    Set LF as the newline sequence
53    PCRE_NOTBOL        Subject is not the beginning of a line    PCRE_NOTBOL        Subject is not the beginning of a line
54    PCRE_NOTEOL        Subject is not the end of a line    PCRE_NOTEOL        Subject is not the end of a line
55    PCRE_NOTEMPTY      An empty string is not a valid match    PCRE_NOTEMPTY      An empty string is not a valid match
56  </PRE>    PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
57                           validity (only relevant if PCRE_UTF8
58                           was set at compile time)
59      PCRE_PARTIAL       Return PCRE_ERROR_PARTIAL for a partial match
60    </pre>
61    There are restrictions on what may appear in a pattern when partial matching is
62    requested. For details, see the
63    <a href="pcrepartial.html"><b>pcrepartial</b></a>
64    page.
65    </P>
66    <P>
67    A <b>pcre_extra</b> structure contains the following fields:
68    <pre>
69      <i>flags</i>        Bits indicating which fields are set
70      <i>study_data</i>   Opaque data from <b>pcre_study()</b>
71      <i>match_limit</i>  Limit on internal resource use
72      <i>match_limit_recursion</i>  Limit on internal recursion depth
73      <i>callout_data</i> Opaque data passed back to callouts
74      <i>tables</i>       Points to character tables or is NULL
75    </pre>
76    The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
77    PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
78    PCRE_EXTRA_TABLES.
79  </P>  </P>
80  <P>  <P>
81  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
82  <a href="pcreapi.html"><b>pcreapi</b></a>  <a href="pcreapi.html"><b>pcreapi</b></a>
83    page and a description of the POSIX API in the
84    <a href="pcreposix.html"><b>pcreposix</b></a>
85  page.  page.
86    <p>
87    Return to the <a href="index.html">PCRE index page</a>.
88    </p>

Legend:
Removed from v.63  
changed lines
  Added in v.150

  ViewVC Help
Powered by ViewVC 1.1.5