FM / html

/usr/share/doc/pcre2-devel/html

Name	Size	Mode	Actions
index.html	13975	0644	edit dl rm
NON-AUTOTOOLS-BUILD.txt	18447	0644	edit dl rm
pcre2-config.html	3498	0644	edit dl rm
pcre2.html	9909	0644	edit dl rm
pcre2api.html	188192	0644	edit dl rm
pcre2build.html	26987	0644	edit dl rm
pcre2callout.html	20379	0644	edit dl rm
pcre2compat.html	11484	0644	edit dl rm
pcre2convert.html	7892	0644	edit dl rm
pcre2demo.html	20854	0644	edit dl rm
pcre2grep.html	52631	0644	edit dl rm
pcre2jit.html	21785	0644	edit dl rm
pcre2limits.html	3239	0644	edit dl rm
pcre2matching.html	11153	0644	edit dl rm
pcre2partial.html	18580	0644	edit dl rm
pcre2pattern.html	167849	0644	edit dl rm
pcre2perform.html	11845	0644	edit dl rm
pcre2posix.html	15881	0644	edit dl rm
pcre2sample.html	3905	0644	edit dl rm
pcre2serialize.html	10059	0644	edit dl rm
pcre2syntax.html	22770	0644	edit dl rm
pcre2test.html	94238	0644	edit dl rm
pcre2unicode.html	21071	0644	edit dl rm
pcre2_callout_enumerate.html	2431	0644	edit dl rm
pcre2_code_copy.html	1370	0644	edit dl rm
pcre2_code_copy_with_tables.html	1491	0644	edit dl rm
pcre2_code_free.html	1243	0644	edit dl rm
pcre2_compile.html	4556	0644	edit dl rm
pcre2_compile_context_copy.html	1176	0644	edit dl rm
pcre2_compile_context_create.html	1271	0644	edit dl rm
pcre2_compile_context_free.html	1233	0644	edit dl rm
pcre2_config.html	3575	0644	edit dl rm
pcre2_converted_pattern_free.html	1249	0644	edit dl rm
pcre2_convert_context_copy.html	1157	0644	edit dl rm
pcre2_convert_context_create.html	1251	0644	edit dl rm
pcre2_convert_context_free.html	1214	0644	edit dl rm
pcre2_dfa_match.html	3865	0644	edit dl rm
pcre2_general_context_copy.html	1225	0644	edit dl rm
pcre2_general_context_create.html	1486	0644	edit dl rm
pcre2_general_context_free.html	1172	0644	edit dl rm
pcre2_get_error_message.html	1745	0644	edit dl rm
pcre2_get_mark.html	1505	0644	edit dl rm
pcre2_get_match_data_size.html	1053	0644	edit dl rm
pcre2_get_ovector_count.html	1072	0644	edit dl rm
pcre2_get_ovector_pointer.html	1148	0644	edit dl rm
pcre2_get_startchar.html	1430	0644	edit dl rm
pcre2_jit_compile.html	2238	0644	edit dl rm
pcre2_jit_free_unused_memory.html	1328	0644	edit dl rm
pcre2_jit_match.html	2143	0644	edit dl rm
pcre2_jit_stack_assign.html	2562	0644	edit dl rm
pcre2_jit_stack_create.html	1825	0644	edit dl rm
pcre2_jit_stack_free.html	1223	0644	edit dl rm
pcre2_maketables.html	1647	0644	edit dl rm
pcre2_maketables_free.html	1223	0644	edit dl rm
pcre2_match.html	3673	0644	edit dl rm
pcre2_match_context_copy.html	1164	0644	edit dl rm
pcre2_match_context_create.html	1261	0644	edit dl rm
pcre2_match_context_free.html	1223	0644	edit dl rm
pcre2_match_data_create.html	1755	0644	edit dl rm
pcre2_match_data_create_from_pattern.html	1930	0644	edit dl rm
pcre2_match_data_free.html	1417	0644	edit dl rm
pcre2_pattern_convert.html	2663	0644	edit dl rm
pcre2_pattern_info.html	4816	0644	edit dl rm
pcre2_serialize_decode.html	2547	0644	edit dl rm
pcre2_serialize_encode.html	2721	0644	edit dl rm
pcre2_serialize_free.html	1187	0644	edit dl rm
pcre2_serialize_get_number_of_codes.html	1634	0644	edit dl rm
pcre2_set_bsr.html	1199	0644	edit dl rm
pcre2_set_callout.html	1276	0644	edit dl rm
pcre2_set_character_tables.html	1437	0644	edit dl rm
pcre2_set_compile_extra_options.html	1713	0644	edit dl rm
pcre2_set_compile_recursion_guard.html	1664	0644	edit dl rm
pcre2_set_depth_limit.html	1080	0644	edit dl rm
pcre2_set_glob_escape.html	1365	0644	edit dl rm
pcre2_set_glob_separator.html	1336	0644	edit dl rm
pcre2_set_heap_limit.html	1076	0644	edit dl rm
pcre2_set_match_limit.html	1067	0644	edit dl rm
pcre2_set_max_pattern_length.html	1336	0644	edit dl rm
pcre2_set_newline.html	1566	0644	edit dl rm
pcre2_set_offset_limit.html	1073	0644	edit dl rm
pcre2_set_parens_nest_limit.html	1122	0644	edit dl rm
pcre2_set_recursion_limit.html	1097	0644	edit dl rm
pcre2_set_recursion_memory_management.html	1245	0644	edit dl rm
pcre2_set_substitute_callout.html	1331	0644	edit dl rm
pcre2_substitute.html	4953	0644	edit dl rm
pcre2_substring_copy_byname.html	2059	0644	edit dl rm
pcre2_substring_copy_bynumber.html	1860	0644	edit dl rm
pcre2_substring_free.html	1196	0644	edit dl rm
pcre2_substring_get_byname.html	2187	0644	edit dl rm
pcre2_substring_get_bynumber.html	2023	0644	edit dl rm
pcre2_substring_length_byname.html	1364	0644	edit dl rm
pcre2_substring_length_bynumber.html	1518	0644	edit dl rm
pcre2_substring_list_free.html	1211	0644	edit dl rm
pcre2_substring_list_get.html	2136	0644	edit dl rm
pcre2_substring_nametable_scan.html	1837	0644	edit dl rm
pcre2_substring_number_from_name.html	1645	0644	edit dl rm
README.txt	43547	0644	edit dl rm

Edit: /usr/share/doc/pcre2-devel/html/pcre2_substitute.html (4953B)

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

cmd: