Return to pcre_get_named_substring.3 CVS log

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

8.33

    1: .TH PCRE_GET_NAMED_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
    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_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 const char **\fIstringptr\fP);
   17: .PP
   18: .B int pcre16_get_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_SPTR16 *\fIstringptr\fP);
   25: .PP
   26: .B int pcre32_get_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_SPTR32 *\fIstringptr\fP);
   33: .
   34: .SH DESCRIPTION
   35: .rs
   36: .sp
   37: This is a convenience function for extracting a captured substring by name. The
   38: arguments are:
   39: .sp
   40:   \fIcode\fP          Compiled pattern
   41:   \fIsubject\fP       Subject that has been successfully matched
   42:   \fIovector\fP       Offset vector that \fBpcre[16|32]_exec()\fP used
   43:   \fIstringcount\fP   Value returned by \fBpcre[16|32]_exec()\fP
   44:   \fIstringname\fP    Name of the required substring
   45:   \fIstringptr\fP     Where to put the string pointer
   46: .sp
   47: The memory in which the substring is placed is obtained by calling
   48: \fBpcre[16|32]_malloc()\fP. The convenience function
   49: \fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer
   50: needed. The yield of the function is the length of the extracted substring,
   51: PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
   52: PCRE_ERROR_NOSUBSTRING if the string name is invalid.
   53: .P
   54: There is a complete description of the PCRE native API in the
   55: .\" HREF
   56: \fBpcreapi\fP
   57: .\"
   58: page and a description of the POSIX API in the
   59: .\" HREF
   60: \fBpcreposix\fP
   61: .\"
   62: page.