22

✏️ Editing: pcre2_callout_enumerate.html

<html>
<head>
<title>pcre2_callout_enumerate specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2_callout_enumerate 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_callout_enumerate(const pcre2_code *code,
 int (*callback)(pcre2_callout_enumerate_block *, void *),
 void *callout_data);

 
DESCRIPTION
 

This function scans a compiled regular expression and calls the callback()
function for each callout within the pattern. The yield of the function is zero
for success and non-zero otherwise. The arguments are:
<pre>
 code Points to the compiled pattern
 callback The callback function
 callout_data User data that is passed to the callback
</pre>
The callback() function is passed a pointer to a data block containing
the following fields (not necessarily in this order):
<pre>
 uint32_t version Block version number
 uint32_t callout_number Number for numbered callouts
 PCRE2_SIZE pattern_position Offset to next item in pattern
 PCRE2_SIZE next_item_length Length of next item in pattern
 PCRE2_SIZE callout_string_offset Offset to string within pattern
 PCRE2_SIZE callout_string_length Length of callout string
 PCRE2_SPTR callout_string Points to callout string or is NULL
</pre>
The second argument passed to the callback() function is the callout data
that was passed to pcre2_callout_enumerate(). The callback()
function must return zero for success. Any other value causes the pattern scan
to stop, with the value being passed back as the result of
pcre2_callout_enumerate().


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