Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pcre2_substring_nametable_scan (3)

Name

pcre2_substring_nametable_scan - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

int pcre2_substring_nametable_scan(const pcre2_code *code,
PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last);

Description

Library Functions Manual                     PCRE2_SUBSTRING_NAMETABLE_SCAN(3)



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

SYNOPSIS

       #include <pcre2.h>

       int pcre2_substring_nametable_scan(const pcre2_code *code,
         PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last);

DESCRIPTION

       This  convenience function finds, for a compiled pattern, the first and
       last entries for a given name in the table  that  translates  capturing
       parenthesis names into numbers.

         code    Compiled regular expression
         name    Name whose entries required
         first   Where to return a pointer to the first entry
         last    Where to return a pointer to the last entry

       When  the  name  is  found in the table, if first is NULL, the function
       returns a group number, but if there is more than one  matching  entry,
       it  is  not  defined which one. Otherwise, when both pointers have been
       set, the yield of the function is the length  of  each  entry  in  code
       units. If the name is not found, PCRE2_ERROR_NOSUBSTRING is returned.

       There  is a complete description of the PCRE2 native API, including the
       format of the table entries, 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.00                     21 October 2014
                                             PCRE2_SUBSTRING_NAMETABLE_SCAN(3)