Annotation of embedaddon/pcre/doc/pcre_get_substring.3, revision 1.1.1.2
1.1 misho 1: .TH PCRE_GET_SUBSTRING 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: .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);
1.1.1.2 ! misho 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);
1.1 misho 21: .
22: .SH DESCRIPTION
23: .rs
24: .sp
25: This is a convenience function for extracting a captured substring. The
26: arguments are:
27: .sp
28: \fIsubject\fP Subject that has been successfully matched
1.1.1.2 ! misho 29: \fIovector\fP Offset vector that \fBpcre[16]_exec()\fP used
! 30: \fIstringcount\fP Value returned by \fBpcre[16]_exec()\fP
1.1 misho 31: \fIstringnumber\fP Number of the required substring
32: \fIstringptr\fP Where to put the string pointer
33: .sp
34: The memory in which the substring is placed is obtained by calling
1.1.1.2 ! misho 35: \fBpcre[16]_malloc()\fP. The convenience function
! 36: \fBpcre[16]_free_substring()\fP can be used to free it when it is no longer
! 37: needed. The yield of the function is the length of the substring,
! 38: PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
! 39: PCRE_ERROR_NOSUBSTRING if the string number is invalid.
1.1 misho 40: .P
41: There is a complete description of the PCRE native API in the
42: .\" HREF
43: \fBpcreapi\fP
44: .\"
45: page and a description of the POSIX API in the
46: .\" HREF
47: \fBpcreposix\fP
48: .\"
49: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>