src/external/pcre2-10.32/doc/pcre2_get_mark.3

   1 .TH PCRE2_GET_MARK 3 "13 October 2017" "PCRE2 10.31"
   2 .SH NAME
   3 PCRE2 - Perl-compatible regular expressions (revised API)
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre2.h>
   8 .PP
   9 .nf
  10 .B PCRE2_SPTR pcre2_get_mark(pcre2_match_data *\fImatch_data\fP);
  11 .fi
  12 .
  13 .SH DESCRIPTION
  14 .rs
  15 .sp
  16 After a call of \fBpcre2_match()\fP that was passed the match block that is
  17 this function's argument, this function returns a pointer to the last (*MARK),
  18 (*PRUNE), or (*THEN) name that was encountered during the matching process. The
  19 name is zero-terminated, and is within the compiled pattern. The length of the
  20 name is in the preceding code unit. If no name is available, NULL is returned.
  21 .P
  22 After a successful match, the name that is returned is the last one on the
  23 matching path. After a failed match or a partial match, the last encountered
  24 name is returned.
  25 .P
  26 There is a complete description of the PCRE2 native API in the
  27 .\" HREF
  28 \fBpcre2api\fP
  29 .\"
  30 page and a description of the POSIX API in the
  31 .\" HREF
  32 \fBpcre2posix\fP
  33 .\"
  34 page.