22

✏️ Editing: pcre2_substring_copy_bynumber.html

<html>
<head>
<title>pcre2_substring_copy_bynumber specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2_substring_copy_bynumber man page</h1>

Return to the <a href="index.html">PCRE2 index page</a>.


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.
 
 
SYNOPSIS
 

#include &#60;pcre2.h&#62;


int pcre2_substring_copy_bynumber(pcre2_match_data *match_data,
 uint32_t number, PCRE2_UCHAR *buffer,
 PCRE2_SIZE *bufflen);

 
DESCRIPTION
 

This is a convenience function for extracting a captured substring into a given
buffer. The arguments are:
<pre>
 match_data The match data block for the match
 number Number of the required substring
 buffer Buffer to receive the string
 bufflen Length of buffer
</pre>
The bufflen variable is updated with the length of the extracted string,
excluding the terminating zero. The yield of the function is zero for success
or one of the following error numbers:
<pre>
 PCRE2_ERROR_NOSUBSTRING there are no groups of that number
 PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group
 PCRE2_ERROR_UNSET the group did not participate in the match
 PCRE2_ERROR_NOMEMORY the buffer is too small

</PRE>


There is a complete description of the PCRE2 native API in the
<a href="pcre2api.html">pcre2api</a>
page and a description of the POSIX API in the
<a href="pcre2posix.html">pcre2posix</a>
page.

Return to the <a href="index.html">PCRE2 index page</a>.

MR SKB