Annotation of embedaddon/pcre/doc/pcre_get_named_substring.3, revision 1.1.1.3
1.1.1.3 ! misho 1: .TH PCRE_GET_NAMED_SUBSTRING 3 "13 January 2012" "PCRE 8.30"
1.1 misho 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_named_substring(const pcre *\fIcode\fP,
11: .ti +5n
12: .B const char *\fIsubject\fP, int *\fIovector\fP,
13: .ti +5n
14: .B int \fIstringcount\fP, const char *\fIstringname\fP,
15: .ti +5n
16: .B const char **\fIstringptr\fP);
1.1.1.2 misho 17: .PP
18: .B int pcre16_get_named_substring(const pcre16 *\fIcode\fP,
19: .ti +5n
20: .B PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
21: .ti +5n
22: .B int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP,
23: .ti +5n
24: .B PCRE_SPTR16 *\fIstringptr\fP);
1.1 misho 25: .
26: .SH DESCRIPTION
27: .rs
28: .sp
29: This is a convenience function for extracting a captured substring by name. The
30: arguments are:
31: .sp
32: \fIcode\fP Compiled pattern
33: \fIsubject\fP Subject that has been successfully matched
1.1.1.2 misho 34: \fIovector\fP Offset vector that \fBpcre[16]_exec()\fP used
35: \fIstringcount\fP Value returned by \fBpcre[16]_exec()\fP
1.1 misho 36: \fIstringname\fP Name of the required substring
37: \fIstringptr\fP Where to put the string pointer
38: .sp
39: The memory in which the substring is placed is obtained by calling
1.1.1.2 misho 40: \fBpcre[16]_malloc()\fP. The convenience function
41: \fBpcre[16]_free_substring()\fP can be used to free it when it is no longer
42: needed. The yield of the function is the length of the extracted substring,
43: PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
44: PCRE_ERROR_NOSUBSTRING if the string name is invalid.
1.1 misho 45: .P
46: There is a complete description of the PCRE native API in the
47: .\" HREF
48: \fBpcreapi\fP
49: .\"
50: page and a description of the POSIX API in the
51: .\" HREF
52: \fBpcreposix\fP
53: .\"
54: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>