Return to pcre_copy_named_substring.3 CVS log

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

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

1.1.1.4   misho       1: .TH PCRE_COPY_NAMED_SUBSTRING 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_copy_named_substring(const pcre *\fIcode\fP,
1.1.1.5 ! misho      11: .B "     const char *\fIsubject\fP, int *\fIovector\fP,"
        !            12: .B "     int \fIstringcount\fP, const char *\fIstringname\fP,"
        !            13: .B "     char *\fIbuffer\fP, int \fIbuffersize\fP);"
        !            14: .sp
1.1.1.2   misho      15: .B int pcre16_copy_named_substring(const pcre16 *\fIcode\fP,
1.1.1.5 ! misho      16: .B "     PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,"
        !            17: .B "     int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP,"
        !            18: .B "     PCRE_UCHAR16 *\fIbuffer\fP, int \fIbuffersize\fP);"
        !            19: .sp
1.1.1.4   misho      20: .B int pcre32_copy_named_substring(const pcre32 *\fIcode\fP,
1.1.1.5 ! misho      21: .B "     PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,"
        !            22: .B "     int \fIstringcount\fP, PCRE_SPTR32 \fIstringname\fP,"
        !            23: .B "     PCRE_UCHAR32 *\fIbuffer\fP, int \fIbuffersize\fP);"
        !            24: .fi
1.1       misho      25: .
                     26: .SH DESCRIPTION
                     27: .rs
                     28: .sp
                     29: This is a convenience function for extracting a captured substring, identified
                     30: by name, into a given buffer. The arguments are:
                     31: .sp
                     32:   \fIcode\fP          Pattern that was successfully matched
                     33:   \fIsubject\fP       Subject that has been successfully matched
1.1.1.4   misho      34:   \fIovector\fP       Offset vector that \fBpcre[16|32]_exec()\fP used
                     35:   \fIstringcount\fP   Value returned by \fBpcre[16|32]_exec()\fP
1.1       misho      36:   \fIstringname\fP    Name of the required substring
                     37:   \fIbuffer\fP        Buffer to receive the string
                     38:   \fIbuffersize\fP    Size of buffer
                     39: .sp
                     40: The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
                     41: too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
                     42: .P
                     43: There is a complete description of the PCRE native API in the
                     44: .\" HREF
                     45: \fBpcreapi\fP
                     46: .\"
                     47: page and a description of the POSIX API in the
                     48: .\" HREF
                     49: \fBpcreposix\fP
                     50: .\"
                     51: page.