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.4

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