AnonymousFox

//opt/pcre/share/doc/pcre/html/pcre_copy_substring.html

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

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


This page is part of the PCRE 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;pcre.h&#62;


int pcre_copy_substring(const char *subject, int *ovector,
 int stringcount, int stringnumber, char *buffer,
 int buffersize);
 
 
int pcre16_copy_substring(PCRE_SPTR16 subject, int *ovector,
 int stringcount, int stringnumber, PCRE_UCHAR16 *buffer,
 int buffersize);
 
 
int pcre32_copy_substring(PCRE_SPTR32 subject, int *ovector,
 int stringcount, int stringnumber, PCRE_UCHAR32 *buffer,
 int buffersize);

 
DESCRIPTION
 

This is a convenience function for extracting a captured substring into a given
buffer. The arguments are:
<pre>
 subject Subject that has been successfully matched
 ovector Offset vector that pcre[16|32]_exec() used
 stringcount Value returned by pcre[16|32]_exec()
 stringnumber Number of the required substring
 buffer Buffer to receive the string
 buffersize Size of buffer
</pre>
The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.


There is a complete description of the PCRE native API in the
<a href="pcreapi.html">pcreapi</a>
page and a description of the POSIX API in the
<a href="pcreposix.html">pcreposix</a>
page.

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