Annotation of embedaddon/pcre/doc/pcre_get_stringnumber.3, revision 1.1
1.1 ! misho 1: .TH PCRE_GET_STRINGNUMBER 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_stringnumber(const pcre *\fIcode\fP,
! 11: .ti +5n
! 12: .B const char *\fIname\fP);
! 13: .
! 14: .SH DESCRIPTION
! 15: .rs
! 16: .sp
! 17: This convenience function finds the number of a named substring capturing
! 18: parenthesis in a compiled pattern. Its arguments are:
! 19: .sp
! 20: \fIcode\fP Compiled regular expression
! 21: \fIname\fP Name whose number is required
! 22: .sp
! 23: The yield of the function is the number of the parenthesis if the name is
! 24: found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
! 25: (PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
! 26: \fBpcre_get_stringnumber()\fP. You can obtain the complete list by calling
! 27: \fBpcre_get_stringtable_entries()\fP.
! 28: .P
! 29: There is a complete description of the PCRE native API in the
! 30: .\" HREF
! 31: \fBpcreapi\fP
! 32: .\"
! 33: page and a description of the POSIX API in the
! 34: .\" HREF
! 35: \fBpcreposix\fP
! 36: .\"
! 37: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>