--- embedaddon/pcre/doc/pcre_get_substring.3 2012/02/21 23:05:51 1.1 +++ embedaddon/pcre/doc/pcre_get_substring.3 2014/06/15 19:46:05 1.1.1.5 @@ -1,4 +1,4 @@ -.TH PCRE_GET_SUBSTRING 3 +.TH PCRE_GET_SUBSTRING 3 "24 June 2012" "PCRE 8.30" .SH NAME PCRE - Perl-compatible regular expressions .SH SYNOPSIS @@ -6,12 +6,19 @@ PCRE - Perl-compatible regular expressions .sp .B #include .PP -.SM +.nf .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP, -.ti +5n -.B int \fIstringcount\fP, int \fIstringnumber\fP, -.ti +5n -.B const char **\fIstringptr\fP); +.B " int \fIstringcount\fP, int \fIstringnumber\fP," +.B " const char **\fIstringptr\fP);" +.sp +.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP, +.B " int \fIstringcount\fP, int \fIstringnumber\fP," +.B " PCRE_SPTR16 *\fIstringptr\fP);" +.sp +.B int pcre32_get_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP, +.B " int \fIstringcount\fP, int \fIstringnumber\fP," +.B " PCRE_SPTR32 *\fIstringptr\fP);" +.fi . .SH DESCRIPTION .rs @@ -20,16 +27,17 @@ This is a convenience function for extracting a captur arguments are: .sp \fIsubject\fP Subject that has been successfully matched - \fIovector\fP Offset vector that \fBpcre_exec()\fP used - \fIstringcount\fP Value returned by \fBpcre_exec()\fP + \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used + \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP \fIstringnumber\fP Number of the required substring \fIstringptr\fP Where to put the string pointer .sp The memory in which the substring is placed is obtained by calling -\fBpcre_malloc()\fP. The convenience function \fBpcre_free_substring()\fP can -be used to free it when it is no longer needed. The yield of the function is -the length of the substring, PCRE_ERROR_NOMEMORY if sufficient memory could not -be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is invalid. +\fBpcre[16|32]_malloc()\fP. The convenience function +\fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer +needed. The yield of the function is the length of the substring, +PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE_ERROR_NOSUBSTRING if the string number is invalid. .P There is a complete description of the PCRE native API in the .\" HREF