Return to pcre_get_stringnumber.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_get_stringnumber.3, revision 1.1.1.5

1.1.1.4   misho       1: .TH PCRE_GET_STRINGNUMBER 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_stringnumber(const pcre *\fIcode\fP,
1.1.1.5 ! misho      11: .B "     const char *\fIname\fP);"
        !            12: .sp
1.1.1.2   misho      13: .B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
1.1.1.5 ! misho      14: .B "     PCRE_SPTR16 \fIname\fP);"
        !            15: .sp
1.1.1.4   misho      16: .B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP,
1.1.1.5 ! misho      17: .B "     PCRE_SPTR32 \fIname\fP);"
        !            18: .fi
1.1       misho      19: .
                     20: .SH DESCRIPTION
                     21: .rs
                     22: .sp
                     23: This convenience function finds the number of a named substring capturing
                     24: parenthesis in a compiled pattern. Its arguments are:
                     25: .sp
                     26:   \fIcode\fP    Compiled regular expression
                     27:   \fIname\fP    Name whose number is required
                     28: .sp
                     29: The yield of the function is the number of the parenthesis if the name is
                     30: found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
                     31: (PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
1.1.1.4   misho      32: \fBpcre[16|32]_get_stringnumber()\fP. You can obtain the complete list by calling
                     33: \fBpcre[16|32]_get_stringtable_entries()\fP.
1.1       misho      34: .P
                     35: There is a complete description of the PCRE native API in the
                     36: .\" HREF
                     37: \fBpcreapi\fP
                     38: .\"
                     39: page and a description of the POSIX API in the
                     40: .\" HREF
                     41: \fBpcreposix\fP
                     42: .\"
                     43: page.