new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / html / pcre2_get_mark.html
1 <html>
2 <head>
3 <title>pcre2_get_mark specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre2_get_mark man page</h1>
7 <p>
8 Return to the <a href="index.html">PCRE2 index page</a>.
9 </p>
10 <p>
11 This page is part of the PCRE2 HTML documentation. It was generated
12 automatically from the original man page. If there is any nonsense in it,
13 please consult the man page, in case the conversion went wrong.
14 <br>
15 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre2.h&#62;</b>
20 </P>
21 <P>
22 <b>PCRE2_SPTR pcre2_get_mark(pcre2_match_data *<i>match_data</i>);</b>
23 </P>
24 <br><b>
25 DESCRIPTION
26 </b><br>
27 <P>
28 After a call of <b>pcre2_match()</b> that was passed the match block that is
29 this function's argument, this function returns a pointer to the last (*MARK),
30 (*PRUNE), or (*THEN) name that was encountered during the matching process. The
31 name is zero-terminated, and is within the compiled pattern. The length of the
32 name is in the preceding code unit. If no name is available, NULL is returned.
33 </P>
34 <P>
35 After a successful match, the name that is returned is the last one on the
36 matching path. After a failed match or a partial match, the last encountered
37 name is returned.
38 </P>
39 <P>
40 There is a complete description of the PCRE2 native API in the
41 <a href="pcre2api.html"><b>pcre2api</b></a>
42 page and a description of the POSIX API in the
43 <a href="pcre2posix.html"><b>pcre2posix</b></a>
44 page.
45 <p>
46 Return to the <a href="index.html">PCRE2 index page</a>.
47 </p>