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

Contents of /code/trunk/doc/html/pcre_get_substring.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 869 - (show annotations)
Sat Jan 14 11:16:23 2012 UTC (9 years, 3 months ago) by ph10
File MIME type: text/html
File size: 2014 byte(s)
Error occurred while calculating annotation data.
Bring HTML docs up to date.
1 <html>
2 <head>
3 <title>pcre_get_substring specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre_get_substring 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 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre.h&#62;</b>
20 </P>
21 <P>
22 <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
23 <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
24 <b>const char **<i>stringptr</i>);</b>
25 </P>
26 <P>
27 <b>int pcre16_get_substring(PCRE_SPTR16 <i>subject</i>, int *<i>ovector</i>,</b>
28 <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
29 <b>PCRE_SPTR16 *<i>stringptr</i>);</b>
30 </P>
31 <br><b>
32 DESCRIPTION
33 </b><br>
34 <P>
35 This is a convenience function for extracting a captured substring. The
36 arguments are:
37 <pre>
38 <i>subject</i> Subject that has been successfully matched
39 <i>ovector</i> Offset vector that <b>pcre[16]_exec()</b> used
40 <i>stringcount</i> Value returned by <b>pcre[16]_exec()</b>
41 <i>stringnumber</i> Number of the required substring
42 <i>stringptr</i> Where to put the string pointer
43 </pre>
44 The memory in which the substring is placed is obtained by calling
45 <b>pcre[16]_malloc()</b>. The convenience function
46 <b>pcre[16]_free_substring()</b> can be used to free it when it is no longer
47 needed. The yield of the function is the length of the substring,
48 PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
49 PCRE_ERROR_NOSUBSTRING if the string number is invalid.
50 </P>
51 <P>
52 There is a complete description of the PCRE native API in the
53 <a href="pcreapi.html"><b>pcreapi</b></a>
54 page and a description of the POSIX API in the
55 <a href="pcreposix.html"><b>pcreposix</b></a>
56 page.
57 <p>
58 Return to the <a href="index.html">PCRE index page</a>.
59 </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5