~ubuntu-branches/ubuntu/hoary/pcre3/hoary-security

« back to all changes in this revision

Viewing changes to doc/pcre_get_stringnumber.3

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2004-03-12 13:23:02 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040312132302-id6ksx1l8dwssbw9
Tags: 4.5-1.1
* NMU to fix rc-bugs.
* Update libtool related files to fix build-error on mips, keep original
  config.in, as it is no generated file. (Closes: #237265)
* pcregrep replaces pgrep. (Closes: #237564)
* Bump shlibs, pcre 4.5 includes two new functions.
* Let pgrep's /usr/share/doc symlink point to the package it depends on,
  pcregrep.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH PCRE 3
 
2
.SH NAME
 
3
PCRE - Perl-compatible regular expressions
 
4
.SH SYNOPSIS
 
5
.rs
 
6
.sp
 
7
.B #include <pcre.h>
 
8
.PP
 
9
.SM
 
10
.br
 
11
.B int pcre_get_stringnumber(const pcre *\fIcode\fR,
 
12
.ti +5n
 
13
.B const char *\fIname\fR);
 
14
 
 
15
.SH DESCRIPTION
 
16
.rs
 
17
.sp
 
18
This convenience function finds the number of a named substring capturing
 
19
parenthesis in a compiled pattern. Its arguments are:
 
20
 
 
21
  \fIcode\fR    Compiled regular expression
 
22
  \fIname\fR    Name whose number is required
 
23
 
 
24
The yield of the function is the number of the parenthesis if the name is
 
25
found, or PCRE_ERROR_NOSUBSTRING otherwise.
 
26
 
 
27
There is a complete description of the PCRE API in the
 
28
.\" HREF
 
29
\fBpcreapi\fR
 
30
.\"
 
31
page.