summaryrefslogtreecommitdiff
path: root/doc/html/pcre2_substitute.html
diff options
context:
space:
mode:
authorph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2017-03-26 15:44:09 +0000
committerph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2017-03-26 15:44:09 +0000
commitbf1fbe25f6cf246475c28f5a1aa6e7676d502728 (patch)
treedd402658f9b3fa6c60e4ab900480acbd060e8929 /doc/html/pcre2_substitute.html
parent55f5d081c04b7c8e6b5867ccfad3c731a2cc6870 (diff)
downloadpcre2-bf1fbe25f6cf246475c28f5a1aa6e7676d502728.tar.gz
Documentation update.
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@710 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/html/pcre2_substitute.html')
-rw-r--r--doc/html/pcre2_substitute.html21
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/html/pcre2_substitute.html b/doc/html/pcre2_substitute.html
index 2dfd094..40cbe04 100644
--- a/doc/html/pcre2_substitute.html
+++ b/doc/html/pcre2_substitute.html
@@ -47,26 +47,29 @@ Its arguments are:
<i>outputbuffer</i> Points to the output buffer
<i>outlengthptr</i> Points to the length of the output buffer
</pre>
-A match context is needed only if you want to:
+A match data block is needed only if you want to inspect the data from the
+match that is returned in that block. A match context is needed only if you
+want to:
<pre>
Set up a callout function
- Change the limit for calling the internal function <i>match()</i>
- Change the limit for calling <i>match()</i> recursively
- Set custom memory management when the heap is used for recursion
+ 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 <i>length</i>, <i>startoffset</i> and <i>rlength</i> values are code
units, not characters, as is the contents of the variable pointed at by
<i>outlengthptr</i>, which is updated to the actual length of the new string.
-The options are:
+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_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_UTF_CHECK Do not check the subject or replacement
- for UTF validity (only relevant if
+ 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 the subject or replacement for UTF validity (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