Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pcre2_substring_number_from_name (3)

Name

pcre2_substring_number_from_name - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

int pcre2_substring_number_from_name(const pcre2_code *code,
PCRE2_SPTR name);

Description

Library Functions Manual                   PCRE2_SUBSTRING_NUMBER_FROM_NAME(3)



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

SYNOPSIS

       #include <pcre2.h>

       int pcre2_substring_number_from_name(const pcre2_code *code,
         PCRE2_SPTR name);

DESCRIPTION

       This convenience function finds the number of a named substring captur-
       ing parenthesis in a compiled pattern, provided that  it  is  a  unique
       name. The function arguments are:

         code    Compiled regular expression
         name    Name whose number is required

       The  yield of the function is the number of the parenthesis if the name
       is found, or PCRE2_ERROR_NOSUBSTRING if it is not found. When duplicate
       names  are  allowed (PCRE2_DUPNAMES is set), if the name is not unique,
       PCRE2_ERROR_NOUNIQUESUBSTRING is returned. You can obtain the  list  of
       numbers with the same name by calling pcre2_substring_nametable_scan().

       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.00                     21 October 2014
                                           PCRE2_SUBSTRING_NUMBER_FROM_NAME(3)