Reference for package '#rtl'

StringReplace

Optimized search-and-replace algorithm

Declaration

Source position: strutils.pp line 267

  function StringReplace(const S: string; const OldPattern: string; 
                        const NewPattern: string; Flags: TReplaceFlags; 
                        out aCount: Integer; 
                        Algorithm: TStringReplaceAlgorithm) : string
                        ;  Overload;
  function StringReplace(const S: string; const OldPattern: string; 
                        const NewPattern: string; Flags: TReplaceFlags; 
                        Algorithm: TStringReplaceAlgorithm) : string
                        ;  Overload;
  function StringReplace(const S: UnicodeString; 
                        const OldPattern: UnicodeString; 
                        const NewPattern: UnicodeString; 
                        Flags: TReplaceFlags) : UnicodeString;  Overload;
  function StringReplace(const S: WideString; 
                        const OldPattern: WideString; 
                        const NewPattern: WideString; 
                        Flags: TReplaceFlags) : WideString;  Overload;

Description

StringReplace replaces one or all occurrences of OldPattern with NewPattern in the string S. The behaviour is controlled by Flags and the search mechanism may be optimized using Algorithm. A list of possible algorithms is specified in TStringReplaceAlgorithm .

For ansistrings, this is an optimized version of the SysUtils.StringReplace algorithm. For widestrings or unicodestrings, the algorithm parameter is ignored and the default mechanism in sysutils is always used.

Errors

None.

See also

Name Description
SysUtils.StringReplace Replace occurrences of one substring with another in a string.
TStringReplaceAlgorithm Algorithm to use in StringReplace