Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pcre_get_stringnumber (3)

Name

pcre_get_stringnumber - compatible regular expressions

Synopsis

#include <pcre.h>

int pcre_get_stringnumber(const pcre *code,
const char *name);

int pcre16_get_stringnumber(const pcre16 *code,
PCRE_SPTR16 name);

int pcre32_get_stringnumber(const pcre32 *code,
PCRE_SPTR32 name);

Description

PCRE_GET_STRINGNUMBER(3)   Library Functions Manual   PCRE_GET_STRINGNUMBER(3)



NAME
       PCRE - Perl-compatible regular expressions

SYNOPSIS

       #include <pcre.h>

       int pcre_get_stringnumber(const pcre *code,
            const char *name);

       int pcre16_get_stringnumber(const pcre16 *code,
            PCRE_SPTR16 name);

       int pcre32_get_stringnumber(const pcre32 *code,
            PCRE_SPTR32 name);

DESCRIPTION

       This convenience function finds the number of a named substring captur-
       ing parenthesis in a compiled pattern. Its 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 PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are
       allowed (PCRE_DUPNAMES is set), it is not defined which of the  numbers
       is  returned by pcre[16|32]_get_stringnumber(). You can obtain the com-
       plete list by calling pcre[16|32]_get_stringtable_entries().

       There is a complete description of the PCRE native API in  the  pcreapi
       page and a description of the POSIX API in the pcreposix page.



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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/pcre     |
       +---------------+------------------+
       |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/pcre-8.42.tar.gz

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



PCRE 8.30                        24 June 2012         PCRE_GET_STRINGNUMBER(3)