--- code/trunk/doc/pcre_get_stringnumber.3 2007/02/24 21:40:03 63 +++ code/trunk/doc/pcre_get_stringnumber.3 2007/02/24 21:40:52 79 @@ -1,4 +1,4 @@ -.TH PCRE 3 +.TH PCRE_GET_STRINGNUMBER 3 .SH NAME PCRE - Perl-compatible regular expressions .SH SYNOPSIS @@ -8,24 +8,28 @@ .PP .SM .br -.B int pcre_get_stringnumber(const pcre *\fIcode\fR, +.B int pcre_get_stringnumber(const pcre *\fIcode\fP, .ti +5n -.B const char *\fIname\fR); - +.B const char *\fIname\fP); +. .SH DESCRIPTION .rs .sp This convenience function finds the number of a named substring capturing parenthesis in a compiled pattern. Its arguments are: - - \fIcode\fR Compiled regular expression - \fIname\fR Name whose number is required - +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose number is required +.sp The yield of the function is the number of the parenthesis if the name is found, or PCRE_ERROR_NOSUBSTRING otherwise. - -There is a complete description of the PCRE API in the +.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.