| <html> | |
| <head> | |
| <title>pcre2_match_data_create_from_pattern specification</title> | |
| </head> | |
| <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> | |
| <h1>pcre2_match_data_create_from_pattern man page</h1> | |
| <p> | |
| Return to the <a href="index.html">PCRE2 index page</a>. | |
| </p> | |
| <p> | |
| This page is part of the PCRE2 HTML documentation. It was generated | |
| automatically from the original man page. If there is any nonsense in it, | |
| please consult the man page, in case the conversion went wrong. | |
| <br> | |
| <h2> | |
| SYNOPSIS | |
| </h2> | |
| <p> | |
| <b>#include <pcre2.h></b> | |
| </p> | |
| <p> | |
| <b>pcre2_match_data *pcre2_match_data_create_from_pattern(</b> | |
| <b> const pcre2_code *<i>code</i>, pcre2_general_context *<i>gcontext</i>);</b> | |
| </p> | |
| <h2> | |
| DESCRIPTION | |
| </h2> | |
| <p> | |
| This function creates a new match data block for holding the result of a match. | |
| If the first argument is NULL, this function returns NULL, otherwise the first | |
| argument points to a compiled pattern. The number of capturing parentheses | |
| within the pattern is used to compute the number of pairs of offsets that are | |
| required in the match data block. These form the "output vector" (ovector) | |
| within the match data block, and are used to identify the matched string and | |
| any captured substrings when matching with <b>pcre2_match()</b>. If you are | |
| using <b>pcre2_dfa_match()</b>, which uses the output vector in a different way, | |
| you should use <b>pcre2_match_data_create()</b> instead of this function. | |
| </p> | |
| <p> | |
| The second argument points to a general context, for custom memory management, | |
| or is NULL to use the same memory allocator that was used for the compiled | |
| pattern. The result of the function is NULL if the memory for the block could | |
| not be obtained or if NULL was provided as the first argument. | |
| </p> | |
| <p> | |
| There is a complete description of the PCRE2 native API in the | |
| <a href="pcre2api.html"><b>pcre2api</b></a> | |
| page and a description of the POSIX API in the | |
| <a href="pcre2posix.html"><b>pcre2posix</b></a> | |
| page. | |
| <p> | |
| Return to the <a href="index.html">PCRE2 index page</a>. | |
| </p> | |