...

<html>
<head>
<title>pcre2_substitute specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2_substitute 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_substitute(const pcre2_code *code, PCRE2_SPTR subject,
 PCRE2_SIZE length, PCRE2_SIZE startoffset,
 uint32_t options, pcre2_match_data *match_data,
 pcre2_match_context *mcontext, PCRE2_SPTR replacement,
 PCRE2_SIZE rlength, PCRE2_UCHAR *outputbuffer,
 PCRE2_SIZE *outlengthptr);

 
DESCRIPTION
 

This function matches a compiled regular expression against a given subject
string, using a matching algorithm that is similar to Perl's. It then makes a
copy of the subject, substituting a replacement string for what was matched.
Its arguments are:
<pre>
 code Points to the compiled pattern
 subject Points to the subject string
 length Length of the subject string
 startoffset Offset in the subject at which to start matching
 options Option bits
 match_data Points to a match data block, or is NULL
 mcontext Points to a match context, or is NULL
 replacement Points to the replacement string
 rlength Length of the replacement string
 outputbuffer Points to the output buffer
 outlengthptr Points to the length of the output buffer
</pre>
A match data block is needed only if you want to inspect the data from the
final match that is returned in that block or if PCRE2_SUBSTITUTE_MATCHED is
set. A match context is needed only if you want to:
<pre>
 Set up a callout function
 Set a matching offset limit
 Change the backtracking match limit
 Change the backtracking depth limit
 Set custom memory management in the match context
</pre>
The length, startoffset and rlength values are code units,
not characters, as is the contents of the variable pointed at by
outlengthptr. This variable must contain the length of the output buffer
when the function is called. If the function is successful, the value is
changed to the length of the new string, excluding the trailing zero that is
automatically added.


The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for
zero-terminated strings. The options are:
<pre>
 PCRE2_ANCHORED Match only at the first position
 PCRE2_ENDANCHORED Match only at end of subject
 PCRE2_NOTBOL Subject is not the beginning of a line
 PCRE2_NOTEOL Subject is not the end of a line
 PCRE2_NOTEMPTY An empty string is not a valid match
 PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject is not a valid match
 PCRE2_NO_JIT Do not use JIT matching
 PCRE2_NO_UTF_CHECK Do not check for UTF validity in the subject or replacement
 (only relevant if PCRE2_UTF was set at compile time)
 PCRE2_SUBSTITUTE_EXTENDED Do extended replacement processing
 PCRE2_SUBSTITUTE_GLOBAL Replace all occurrences in the subject
 PCRE2_SUBSTITUTE_LITERAL The replacement string is literal
 PCRE2_SUBSTITUTE_MATCHED Use pre-existing match data for first match
 PCRE2_SUBSTITUTE_OVERFLOW_LENGTH If overflow, compute needed length
 PCRE2_SUBSTITUTE_REPLACEMENT_ONLY Return only replacement string(s)
 PCRE2_SUBSTITUTE_UNKNOWN_UNSET Treat unknown group as unset
 PCRE2_SUBSTITUTE_UNSET_EMPTY Simple unset insert = empty string
</pre>
If PCRE2_SUBSTITUTE_LITERAL is set, PCRE2_SUBSTITUTE_EXTENDED,
PCRE2_SUBSTITUTE_UNKNOWN_UNSET, and PCRE2_SUBSTITUTE_UNSET_EMPTY are ignored.


If PCRE2_SUBSTITUTE_MATCHED is set, match_data must be non-NULL; its
contents must be the result of a call to pcre2_match() using the same
pattern and subject.


The function returns the number of substitutions, which may be zero if there
are no matches. The result may be greater than one only when
PCRE2_SUBSTITUTE_GLOBAL is set. In the event of an error, a negative error code
is returned.


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

.	Edit
..	Edit
NON-AUTOTOOLS-BUILD.txt	Edit
README.txt	Edit
index.html	Edit
pcre2-config.html	Edit
pcre2.html	Edit
pcre2_callout_enumerate.html	Edit
pcre2_code_copy.html	Edit
pcre2_code_copy_with_tables.html	Edit
pcre2_code_free.html	Edit
pcre2_compile.html	Edit
pcre2_compile_context_copy.html	Edit
pcre2_compile_context_create.html	Edit
pcre2_compile_context_free.html	Edit
pcre2_config.html	Edit
pcre2_convert_context_copy.html	Edit
pcre2_convert_context_create.html	Edit
pcre2_convert_context_free.html	Edit
pcre2_converted_pattern_free.html	Edit
pcre2_dfa_match.html	Edit
pcre2_general_context_copy.html	Edit
pcre2_general_context_create.html	Edit
pcre2_general_context_free.html	Edit
pcre2_get_error_message.html	Edit
pcre2_get_mark.html	Edit
pcre2_get_match_data_size.html	Edit
pcre2_get_ovector_count.html	Edit
pcre2_get_ovector_pointer.html	Edit
pcre2_get_startchar.html	Edit
pcre2_jit_compile.html	Edit
pcre2_jit_free_unused_memory.html	Edit
pcre2_jit_match.html	Edit
pcre2_jit_stack_assign.html	Edit
pcre2_jit_stack_create.html	Edit
pcre2_jit_stack_free.html	Edit
pcre2_maketables.html	Edit
pcre2_maketables_free.html	Edit
pcre2_match.html	Edit
pcre2_match_context_copy.html	Edit
pcre2_match_context_create.html	Edit
pcre2_match_context_free.html	Edit
pcre2_match_data_create.html	Edit
pcre2_match_data_create_from_pattern.html	Edit
pcre2_match_data_free.html	Edit
pcre2_pattern_convert.html	Edit
pcre2_pattern_info.html	Edit
pcre2_serialize_decode.html	Edit
pcre2_serialize_encode.html	Edit
pcre2_serialize_free.html	Edit
pcre2_serialize_get_number_of_codes.html	Edit
pcre2_set_bsr.html	Edit
pcre2_set_callout.html	Edit
pcre2_set_character_tables.html	Edit
pcre2_set_compile_extra_options.html	Edit
pcre2_set_compile_recursion_guard.html	Edit
pcre2_set_depth_limit.html	Edit
pcre2_set_glob_escape.html	Edit
pcre2_set_glob_separator.html	Edit
pcre2_set_heap_limit.html	Edit
pcre2_set_match_limit.html	Edit
pcre2_set_max_pattern_length.html	Edit
pcre2_set_newline.html	Edit
pcre2_set_offset_limit.html	Edit
pcre2_set_parens_nest_limit.html	Edit
pcre2_set_recursion_limit.html	Edit
pcre2_set_recursion_memory_management.html	Edit
pcre2_set_substitute_callout.html	Edit
pcre2_substitute.html	Edit
pcre2_substring_copy_byname.html	Edit
pcre2_substring_copy_bynumber.html	Edit
pcre2_substring_free.html	Edit
pcre2_substring_get_byname.html	Edit
pcre2_substring_get_bynumber.html	Edit
pcre2_substring_length_byname.html	Edit
pcre2_substring_length_bynumber.html	Edit
pcre2_substring_list_free.html	Edit
pcre2_substring_list_get.html	Edit
pcre2_substring_nametable_scan.html	Edit
pcre2_substring_number_from_name.html	Edit
pcre2api.html	Edit
pcre2build.html	Edit
pcre2callout.html	Edit
pcre2compat.html	Edit
pcre2convert.html	Edit
pcre2demo.html	Edit
pcre2grep.html	Edit
pcre2jit.html	Edit
pcre2limits.html	Edit
pcre2matching.html	Edit
pcre2partial.html	Edit
pcre2pattern.html	Edit
pcre2perform.html	Edit
pcre2posix.html	Edit
pcre2sample.html	Edit
pcre2serialize.html	Edit
pcre2syntax.html	Edit
pcre2test.html	Edit
pcre2unicode.html	Edit