AnonymousFox

//proc/self/root/opt/pcre/share/doc/pcre/html/pcre_get_substring.html

<html>
<head>
<title>pcre_get_substring specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_get_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_get_substring(const char *subject, int *ovector,
 int stringcount, int stringnumber,
 const char **stringptr);
 
 
int pcre16_get_substring(PCRE_SPTR16 subject, int *ovector,
 int stringcount, int stringnumber,
 PCRE_SPTR16 *stringptr);
 
 
int pcre32_get_substring(PCRE_SPTR32 subject, int *ovector,
 int stringcount, int stringnumber,
 PCRE_SPTR32 *stringptr);

 
DESCRIPTION
 

This is a convenience function for extracting a captured substring. 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
 stringptr Where to put the string pointer
</pre>
The memory in which the substring is placed is obtained by calling
pcre[16|32]_malloc(). The convenience function
pcre[16|32]_free_substring() can be used to free it when it is no longer
needed. The yield of the function is the length of the substring,
PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, 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>.