/[pcre]/code/trunk/doc/pcre_get_stringnumber.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_get_stringnumber.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1055 - (show annotations)
Tue Oct 16 15:53:30 2012 UTC (7 years ago) by chpe
File size: 1222 byte(s)
pcre32: Add 32-bit library

Create libpcre32 that operates on 32-bit characters (UTF-32).

This turned out to be surprisingly simple after the UTF-16 support
was introduced; mostly just extra ifdefs and adjusting and adding
some tests.
1 .TH PCRE_GET_STRINGNUMBER 3 "24 June 2012" "PCRE 8.30"
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 .B int pcre_get_stringnumber(const pcre *\fIcode\fP,
11 .ti +5n
12 .B const char *\fIname\fP);
13 .PP
14 .B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
15 .ti +5n
16 .B PCRE_SPTR16 \fIname\fP);
17 .PP
18 .B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP,
19 .ti +5n
20 .B PCRE_SPTR32 \fIname\fP);
21 .
22 .SH DESCRIPTION
23 .rs
24 .sp
25 This convenience function finds the number of a named substring capturing
26 parenthesis in a compiled pattern. Its arguments are:
27 .sp
28 \fIcode\fP Compiled regular expression
29 \fIname\fP Name whose number is required
30 .sp
31 The yield of the function is the number of the parenthesis if the name is
32 found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
33 (PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
34 \fBpcre[16|32]_get_stringnumber()\fP. You can obtain the complete list by calling
35 \fBpcre[16|32]_get_stringtable_entries()\fP.
36 .P
37 There is a complete description of the PCRE native API in the
38 .\" HREF
39 \fBpcreapi\fP
40 .\"
41 page and a description of the POSIX API in the
42 .\" HREF
43 \fBpcreposix\fP
44 .\"
45 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5