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