Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pcre2_match_data_create_from_pattern (3)

Name

pcre2_match_data_create_from_pattern - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

pcre2_match_data *pcre2_match_data_create_from_pattern(
const pcre2_code *code, pcre2_general_context *gcontext);

Description

Library Functions Manual               PCRE2_MATCH_DATA_CREATE_FROM_PATTERN(3)



NAME
       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS

       #include <pcre2.h>

       pcre2_match_data *pcre2_match_data_create_from_pattern(
         const pcre2_code *code, pcre2_general_context *gcontext);

DESCRIPTION

       This function creates a new match data block, which is used for holding
       the result of a match. The first argument points to a compiled pattern.
       The  number of capturing parentheses within the pattern is used to com-
       pute 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.

       The second argument points to a general context, for custom memory man-
       agement, or is NULL to use the same memory allocator as  was  used  for
       the  compiled pattern. The result of the function is NULL if the memory
       for the block could not be obtained.

       There is a complete description of the PCRE2 native API in the pcre2api
       page and a description of the POSIX API in the pcre2posix page.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/pcre2    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  ftp://ftp.csx.cam.ac.uk/pub/software/pro-
       gramming/pcre/pcre2-10.32.tar.gz

       Further information about this software can be found on the open source
       community website at http://pcre.org/.



PCRE2 10.21                      29 July 2015
                                       PCRE2_MATCH_DATA_CREATE_FROM_PATTERN(3)