...

<html>
<head>
<title>pcre_get_substring_list specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_get_substring_list 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_list(const char *subject,
 int *ovector, int stringcount, const char ***listptr);
 
 
int pcre16_get_substring_list(PCRE_SPTR16 subject,
 int *ovector, int stringcount, PCRE_SPTR16 **listptr);
 
 
int pcre32_get_substring_list(PCRE_SPTR32 subject,
 int *ovector, int stringcount, PCRE_SPTR32 **listptr);

 
DESCRIPTION
 

This is a convenience function for extracting a list of all the captured
substrings. 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
 listptr Where to put a pointer to the list
</pre>
The memory in which the substrings and the list are placed is obtained by
calling pcre[16|32]_malloc(). The convenience function
pcre[16|32]_free_substring_list() can be used to free it when it is no
longer needed. A pointer to a list of pointers is put in the variable whose
address is in listptr. The list is terminated by a NULL pointer. The
yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
memory could not be obtained.


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

.	Edit
..	Edit
NON-AUTOTOOLS-BUILD.txt	Edit
README.txt	Edit
index.html	Edit
pcre-config.html	Edit
pcre.html	Edit
pcre16.html	Edit
pcre32.html	Edit
pcre_assign_jit_stack.html	Edit
pcre_compile.html	Edit
pcre_compile2.html	Edit
pcre_config.html	Edit
pcre_copy_named_substring.html	Edit
pcre_copy_substring.html	Edit
pcre_dfa_exec.html	Edit
pcre_exec.html	Edit
pcre_free_study.html	Edit
pcre_free_substring.html	Edit
pcre_free_substring_list.html	Edit
pcre_fullinfo.html	Edit
pcre_get_named_substring.html	Edit
pcre_get_stringnumber.html	Edit
pcre_get_stringtable_entries.html	Edit
pcre_get_substring.html	Edit
pcre_get_substring_list.html	Edit
pcre_jit_exec.html	Edit
pcre_jit_stack_alloc.html	Edit
pcre_jit_stack_free.html	Edit
pcre_maketables.html	Edit
pcre_pattern_to_host_byte_order.html	Edit
pcre_refcount.html	Edit
pcre_study.html	Edit
pcre_utf16_to_host_byte_order.html	Edit
pcre_utf32_to_host_byte_order.html	Edit
pcre_version.html	Edit
pcreapi.html	Edit
pcrebuild.html	Edit
pcrecallout.html	Edit
pcrecompat.html	Edit
pcrecpp.html	Edit
pcredemo.html	Edit
pcregrep.html	Edit
pcrejit.html	Edit
pcrelimits.html	Edit
pcrematching.html	Edit
pcrepartial.html	Edit
pcrepattern.html	Edit
pcreperform.html	Edit
pcreposix.html	Edit
pcreprecompile.html	Edit
pcresample.html	Edit
pcrestack.html	Edit
pcresyntax.html	Edit
pcretest.html	Edit
pcreunicode.html	Edit