1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- <html>
- <head>
- <title>pcre2_substring_number_from_name specification</title>
- </head>
- <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
- <h1>pcre2_substring_number_from_name man page</h1>
- <p>
- Return to the <a href="index.html">PCRE2 index page</a>.
- </p>
- <p>
- This page is part of the PCRE2 HTML documentation. It was generated
- automatically from the original man page. If there is any nonsense in it,
- please consult the man page, in case the conversion went wrong.
- <br>
- <br><b>
- SYNOPSIS
- </b><br>
- <P>
- <b>#include <pcre2.h></b>
- </P>
- <P>
- <b>int pcre2_substring_number_from_name(const pcre2_code *<i>code</i>,</b>
- <b> PCRE2_SPTR <i>name</i>);</b>
- </P>
- <br><b>
- DESCRIPTION
- </b><br>
- <P>
- This convenience function finds the number of a named substring capturing
- parenthesis in a compiled pattern, provided that it is a unique name. The
- function arguments are:
- <pre>
- <i>code</i> Compiled regular expression
- <i>name</i> Name whose number is required
- </pre>
- 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 <b>pcre2_substring_nametable_scan()</b>.
- </P>
- <P>
- There is a complete description of the PCRE2 native API in the
- <a href="pcre2api.html"><b>pcre2api</b></a>
- page and a description of the POSIX API in the
- <a href="pcre2posix.html"><b>pcre2posix</b></a>
- page.
- <p>
- Return to the <a href="index.html">PCRE2 index page</a>.
- </p>
|