← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/html/pcre_get_named_substring.html

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/pcre_get_named_substring.html
24
24
<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
25
25
<b>const char **<i>stringptr</i>);</b>
26
26
</P>
 
27
<P>
 
28
<b>int pcre16_get_named_substring(const pcre16 *<i>code</i>,</b>
 
29
<b>PCRE_SPTR16 <i>subject</i>, int *<i>ovector</i>,</b>
 
30
<b>int <i>stringcount</i>, PCRE_SPTR16 <i>stringname</i>,</b>
 
31
<b>PCRE_SPTR16 *<i>stringptr</i>);</b>
 
32
</P>
27
33
<br><b>
28
34
DESCRIPTION
29
35
</b><br>
33
39
<pre>
34
40
  <i>code</i>          Compiled pattern
35
41
  <i>subject</i>       Subject that has been successfully matched
36
 
  <i>ovector</i>       Offset vector that <b>pcre_exec()</b> used
37
 
  <i>stringcount</i>   Value returned by <b>pcre_exec()</b>
 
42
  <i>ovector</i>       Offset vector that <b>pcre[16]_exec()</b> used
 
43
  <i>stringcount</i>   Value returned by <b>pcre[16]_exec()</b>
38
44
  <i>stringname</i>    Name of the required substring
39
45
  <i>stringptr</i>     Where to put the string pointer
40
46
</pre>
41
47
The memory in which the substring is placed is obtained by calling
42
 
<b>pcre_malloc()</b>. The convenience function <b>pcre_free_substring()</b> can
43
 
be used to free it when it is no longer needed. The yield of the function is
44
 
the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory
45
 
could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
 
48
<b>pcre[16]_malloc()</b>. The convenience function
 
49
<b>pcre[16]_free_substring()</b> can be used to free it when it is no longer
 
50
needed. The yield of the function is the length of the extracted substring,
 
51
PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
 
52
PCRE_ERROR_NOSUBSTRING if the string name is invalid.
46
53
</P>
47
54
<P>
48
55
There is a complete description of the PCRE native API in the