doc/html/pcre_get_substring.html

   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 <br>
  26 <br>
  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 <br>
  31 <br>
  32 <b>int pcre32_get_substring(PCRE_SPTR32 <i>subject</i>, int *<i>ovector</i>,</b>
  33 <b>     int <i>stringcount</i>, int <i>stringnumber</i>,</b>
  34 <b>     PCRE_SPTR32 *<i>stringptr</i>);</b>
  35 </P>
  36 <br><b>
  37 DESCRIPTION
  38 </b><br>
  39 <P>
  40 This is a convenience function for extracting a captured substring. The
  41 arguments are:
  42 <pre>
  43   <i>subject</i>       Subject that has been successfully matched
  44   <i>ovector</i>       Offset vector that <b>pcre[16|32]_exec()</b> used
  45   <i>stringcount</i>   Value returned by <b>pcre[16|32]_exec()</b>
  46   <i>stringnumber</i>  Number of the required substring
  47   <i>stringptr</i>     Where to put the string pointer
  48 </pre>
  49 The memory in which the substring is placed is obtained by calling
  50 <b>pcre[16|32]_malloc()</b>. The convenience function
  51 <b>pcre[16|32]_free_substring()</b> can be used to free it when it is no longer
  52 needed. The yield of the function is the length of the substring,
  53 PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
  54 PCRE_ERROR_NOSUBSTRING if the string number is invalid.
  55 </P>
  56 <P>
  57 There is a complete description of the PCRE native API in the
  58 <a href="pcreapi.html"><b>pcreapi</b></a>
  59 page and a description of the POSIX API in the
  60 <a href="pcreposix.html"><b>pcreposix</b></a>
  61 page.
  62 <p>
  63 Return to the <a href="index.html">PCRE index page</a>.
  64 </p>