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

Diff of /code/trunk/doc/html/pcre_get_substring.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 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 3  Line 3 
3  <title>pcre_get_substring specification</title>  <title>pcre_get_substring 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_get_substring 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 23  DESCRIPTION Line 29  DESCRIPTION
29  <P>  <P>
30  This is a convenience function for extracting a captured substring. The  This is a convenience function for extracting a captured substring. The
31  arguments are:  arguments are:
 </P>  
 <P>  
32  <pre>  <pre>
33    <i>subject</i>       Subject that has been successfully matched    <i>subject</i>       Subject that has been successfully matched
34    <i>ovector</i>       Offset vector that <b>pcre_exec()</b> used    <i>ovector</i>       Offset vector that <b>pcre_exec()</b> used
35    <i>stringcount</i>   Value returned by <b>pcre_exec()</b>    <i>stringcount</i>   Value returned by <b>pcre_exec()</b>
36    <i>stringnumber</i>  Number of the required substring    <i>stringnumber</i>  Number of the required substring
37    <i>stringptr</i>     Where to put the string pointer    <i>stringptr</i>     Where to put the string pointer
38  </PRE>  </pre>
39  </P>  The memory in which the substring is placed is obtained by calling
40  <P>  <b>pcre_malloc()</b>. The yield of the function is the length of the substring,
41  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if sufficient  PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
42  memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is  PCRE_ERROR_NOSUBSTRING if the string number is invalid.
 invalid.  
43  </P>  </P>
44  <P>  <P>
45  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
46  <a href="pcreapi.html"><b>pcreapi</b></a>  <a href="pcreapi.html"><b>pcreapi</b></a>
47    page and a description of the POSIX API in the
48    <a href="pcreposix.html"><b>pcreposix</b></a>
49  page.  page.
50    <p>
51    Return to the <a href="index.html">PCRE index page</a>.
52    </p>
Legend:
Removed from v.63  
changed lines
  Added in v.75
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12