#include <pcre2.h>

       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);


       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:

         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

       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:

         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

       The length, startoffset and rlength values are code units, not  charac-
       ters,  as  is  the contents of the variable pointed at by outlengthptr,
       which is updated to the actual length of the new string.   The  subject
       and replacement lengths can be given as PCRE2_ZERO_TERMINATED for zero-
       terminated strings. The options are:

         PCRE2_ANCHORED             Match only at the first position
         PCRE2_ENDANCHORED          Pattern can 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 the subject or replacement

       There is a complete description of the PCRE2 native API in the pcre2api
       page and a description of the POSIX API in the pcre2posix page.

PCRE2 10.30                      04 April 2017             PCRE2_SUBSTITUTE(3)
Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2020 Hurricane Electric. All Rights Reserved.