--- code/trunk/doc/pcre_get_named_substring.3 2007/02/24 21:40:03 63 +++ code/trunk/doc/pcre_get_named_substring.3 2007/02/24 21:40:52 79 @@ -1,4 +1,4 @@ -.TH PCRE 3 +.TH PCRE_GET_NAMED_SUBSTRING 3 .SH NAME PCRE - Perl-compatible regular expressions .SH SYNOPSIS @@ -8,33 +8,38 @@ .PP .SM .br -.B int pcre_get_named_substring(const pcre *\fIcode\fR, +.B int pcre_get_named_substring(const pcre *\fIcode\fP, .ti +5n -.B const char *\fIsubject\fR, int *\fIovector\fR, +.B const char *\fIsubject\fP, int *\fIovector\fP, .ti +5n -.B int \fIstringcount\fR, const char *\fIstringname\fR, +.B int \fIstringcount\fP, const char *\fIstringname\fP, .ti +5n -.B const char **\fIstringptr\fR); - +.B const char **\fIstringptr\fP); +. .SH DESCRIPTION .rs .sp This is a convenience function for extracting a captured substring by name. The arguments are: - - \fIcode\fR Compiled pattern - \fIsubject\fR Subject that has been successfully matched - \fIovector\fR Offset vector that \fBpcre_exec()\fR used - \fIstringcount\fR Value returned by \fBpcre_exec()\fR - \fIstringname\fR Name of the required substring - \fIstringptr\fR Where to put the string pointer - -The yield is the length of the extracted substring, PCRE_ERROR_NOMEMORY if -sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the -string name is invalid. - -There is a complete description of the PCRE API in the +.sp + \fIcode\fP Compiled pattern + \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 + \fIstringname\fP Name 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 yield of the function is the length of the extracted +substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE_ERROR_NOSUBSTRING if the string name is invalid. +.P +There is a complete description of the PCRE native API in the +.\" HREF +\fBpcreapi\fP +.\" +page and a description of the POSIX API in the .\" HREF -\fBpcreapi\fR +\fBpcreposix\fP .\" page.