Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pcre2_substring_length_bynumber (3)

Name

pcre2_substring_length_bynumber - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

int pcre2_substring_length_bynumber(pcre2_match_data *match_data,
uint32_t number, PCRE2_SIZE *length);

Description

Library Functions Manual                    PCRE2_SUBSTRING_LENGTH_BYNUMBER(3)



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

SYNOPSIS

       #include <pcre2.h>

       int pcre2_substring_length_bynumber(pcre2_match_data *match_data,
         uint32_t number, PCRE2_SIZE *length);

DESCRIPTION

       This  function returns the length of a matched substring, identified by
       number.  The arguments are:

         match_data   The match data block for the match
         number       The substring number
         length       Where to return the length, or NULL

       The third argument may be NULL if all you want to know  is  whether  or
       not  a  substring  is  set. The yield is zero on success, or a negative
       error code otherwise. After a partial match, only substring 0 is avail-
       able.

       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                    22 December 2014
                                            PCRE2_SUBSTRING_LENGTH_BYNUMBER(3)