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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1055 - (show annotations)
Tue Oct 16 15:53:30 2012 UTC (6 years, 11 months ago) by chpe
File size: 1678 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_SUBSTRING 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_substring(const char *\fIsubject\fP, int *\fIovector\fP,
11 .ti +5n
12 .B int \fIstringcount\fP, int \fIstringnumber\fP,
13 .ti +5n
14 .B const char **\fIstringptr\fP);
15 .PP
16 .B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
17 .ti +5n
18 .B int \fIstringcount\fP, int \fIstringnumber\fP,
19 .ti +5n
20 .B PCRE_SPTR16 *\fIstringptr\fP);
21 .PP
22 .B int pcre32_get_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
23 .ti +5n
24 .B int \fIstringcount\fP, int \fIstringnumber\fP,
25 .ti +5n
26 .B PCRE_SPTR32 *\fIstringptr\fP);
27 .
28 .SH DESCRIPTION
29 .rs
30 .sp
31 This is a convenience function for extracting a captured substring. The
32 arguments are:
33 .sp
34 \fIsubject\fP Subject that has been successfully matched
35 \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used
36 \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP
37 \fIstringnumber\fP Number of the required substring
38 \fIstringptr\fP Where to put the string pointer
39 .sp
40 The memory in which the substring is placed is obtained by calling
41 \fBpcre[16|32]_malloc()\fP. The convenience function
42 \fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer
43 needed. The yield of the function is the length of the substring,
44 PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
45 PCRE_ERROR_NOSUBSTRING if the string number is invalid.
46 .P
47 There is a complete description of the PCRE native API in the
48 .\" HREF
49 \fBpcreapi\fP
50 .\"
51 page and a description of the POSIX API in the
52 .\" HREF
53 \fBpcreposix\fP
54 .\"
55 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5