1*22dc650dSSadaf Ebrahimi<html> 2*22dc650dSSadaf Ebrahimi<head> 3*22dc650dSSadaf Ebrahimi<title>pcre2_match specification</title> 4*22dc650dSSadaf Ebrahimi</head> 5*22dc650dSSadaf Ebrahimi<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6*22dc650dSSadaf Ebrahimi<h1>pcre2_match man page</h1> 7*22dc650dSSadaf Ebrahimi<p> 8*22dc650dSSadaf EbrahimiReturn to the <a href="index.html">PCRE2 index page</a>. 9*22dc650dSSadaf Ebrahimi</p> 10*22dc650dSSadaf Ebrahimi<p> 11*22dc650dSSadaf EbrahimiThis page is part of the PCRE2 HTML documentation. It was generated 12*22dc650dSSadaf Ebrahimiautomatically from the original man page. If there is any nonsense in it, 13*22dc650dSSadaf Ebrahimiplease consult the man page, in case the conversion went wrong. 14*22dc650dSSadaf Ebrahimi<br> 15*22dc650dSSadaf Ebrahimi<br><b> 16*22dc650dSSadaf EbrahimiSYNOPSIS 17*22dc650dSSadaf Ebrahimi</b><br> 18*22dc650dSSadaf Ebrahimi<P> 19*22dc650dSSadaf Ebrahimi<b>#include <pcre2.h></b> 20*22dc650dSSadaf Ebrahimi</P> 21*22dc650dSSadaf Ebrahimi<P> 22*22dc650dSSadaf Ebrahimi<b>int pcre2_match(const pcre2_code *<i>code</i>, PCRE2_SPTR <i>subject</i>,</b> 23*22dc650dSSadaf Ebrahimi<b> PCRE2_SIZE <i>length</i>, PCRE2_SIZE <i>startoffset</i>,</b> 24*22dc650dSSadaf Ebrahimi<b> uint32_t <i>options</i>, pcre2_match_data *<i>match_data</i>,</b> 25*22dc650dSSadaf Ebrahimi<b> pcre2_match_context *<i>mcontext</i>);</b> 26*22dc650dSSadaf Ebrahimi</P> 27*22dc650dSSadaf Ebrahimi<br><b> 28*22dc650dSSadaf EbrahimiDESCRIPTION 29*22dc650dSSadaf Ebrahimi</b><br> 30*22dc650dSSadaf Ebrahimi<P> 31*22dc650dSSadaf EbrahimiThis function matches a compiled regular expression against a given subject 32*22dc650dSSadaf Ebrahimistring, using a matching algorithm that is similar to Perl's. It returns 33*22dc650dSSadaf Ebrahimioffsets to what it has matched and to captured substrings via the 34*22dc650dSSadaf Ebrahimi<b>match_data</b> block, which can be processed by functions with names that 35*22dc650dSSadaf Ebrahimistart with <b>pcre2_get_ovector_...()</b> or <b>pcre2_substring_...()</b>. The 36*22dc650dSSadaf Ebrahimireturn from <b>pcre2_match()</b> is one more than the highest numbered capturing 37*22dc650dSSadaf Ebrahimipair that has been set (for example, 1 if there are no captures), zero if the 38*22dc650dSSadaf Ebrahimivector of offsets is too small, or a negative error code for no match and other 39*22dc650dSSadaf Ebrahimierrors. The function arguments are: 40*22dc650dSSadaf Ebrahimi<pre> 41*22dc650dSSadaf Ebrahimi <i>code</i> Points to the compiled pattern 42*22dc650dSSadaf Ebrahimi <i>subject</i> Points to the subject string 43*22dc650dSSadaf Ebrahimi <i>length</i> Length of the subject string 44*22dc650dSSadaf Ebrahimi <i>startoffset</i> Offset in the subject at which to start matching 45*22dc650dSSadaf Ebrahimi <i>options</i> Option bits 46*22dc650dSSadaf Ebrahimi <i>match_data</i> Points to a match data block, for results 47*22dc650dSSadaf Ebrahimi <i>mcontext</i> Points to a match context, or is NULL 48*22dc650dSSadaf Ebrahimi</pre> 49*22dc650dSSadaf EbrahimiA match context is needed only if you want to: 50*22dc650dSSadaf Ebrahimi<pre> 51*22dc650dSSadaf Ebrahimi Set up a callout function 52*22dc650dSSadaf Ebrahimi Set a matching offset limit 53*22dc650dSSadaf Ebrahimi Change the heap memory limit 54*22dc650dSSadaf Ebrahimi Change the backtracking match limit 55*22dc650dSSadaf Ebrahimi Change the backtracking depth limit 56*22dc650dSSadaf Ebrahimi Set custom memory management specifically for the match 57*22dc650dSSadaf Ebrahimi</pre> 58*22dc650dSSadaf EbrahimiThe <i>length</i> and <i>startoffset</i> values are code units, not characters. 59*22dc650dSSadaf EbrahimiThe length may be given as PCRE2_ZERO_TERMINATED for a subject that is 60*22dc650dSSadaf Ebrahimiterminated by a binary zero code unit. The options are: 61*22dc650dSSadaf Ebrahimi<pre> 62*22dc650dSSadaf Ebrahimi PCRE2_ANCHORED Match only at the first position 63*22dc650dSSadaf Ebrahimi PCRE2_COPY_MATCHED_SUBJECT 64*22dc650dSSadaf Ebrahimi On success, make a private subject copy 65*22dc650dSSadaf Ebrahimi PCRE2_DISABLE_RECURSELOOP_CHECK 66*22dc650dSSadaf Ebrahimi Only useful in rare cases; use with care 67*22dc650dSSadaf Ebrahimi PCRE2_ENDANCHORED Pattern can match only at end of subject 68*22dc650dSSadaf Ebrahimi PCRE2_NOTBOL Subject string is not the beginning of a line 69*22dc650dSSadaf Ebrahimi PCRE2_NOTEOL Subject string is not the end of a line 70*22dc650dSSadaf Ebrahimi PCRE2_NOTEMPTY An empty string is not a valid match 71*22dc650dSSadaf Ebrahimi PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject is not a valid match 72*22dc650dSSadaf Ebrahimi PCRE2_NO_JIT Do not use JIT matching 73*22dc650dSSadaf Ebrahimi PCRE2_NO_UTF_CHECK Do not check the subject for UTF validity (only relevant if PCRE2_UTF 74*22dc650dSSadaf Ebrahimi was set at compile time) 75*22dc650dSSadaf Ebrahimi PCRE2_PARTIAL_HARD Return PCRE2_ERROR_PARTIAL for a partial match even if there is a full match 76*22dc650dSSadaf Ebrahimi PCRE2_PARTIAL_SOFT Return PCRE2_ERROR_PARTIAL for a partial match if no full matches are found 77*22dc650dSSadaf Ebrahimi</pre> 78*22dc650dSSadaf EbrahimiFor details of partial matching, see the 79*22dc650dSSadaf Ebrahimi<a href="pcre2partial.html"><b>pcre2partial</b></a> 80*22dc650dSSadaf Ebrahimipage. There is a complete description of the PCRE2 native API in the 81*22dc650dSSadaf Ebrahimi<a href="pcre2api.html"><b>pcre2api</b></a> 82*22dc650dSSadaf Ebrahimipage and a description of the POSIX API in the 83*22dc650dSSadaf Ebrahimi<a href="pcre2posix.html"><b>pcre2posix</b></a> 84*22dc650dSSadaf Ebrahimipage. 85*22dc650dSSadaf Ebrahimi<p> 86*22dc650dSSadaf EbrahimiReturn to the <a href="index.html">PCRE2 index page</a>. 87*22dc650dSSadaf Ebrahimi</p> 88