[Overview][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'LazUTF8' (#lazutils)

UTF8StringReplace

Replaces values in a String matching a pattern starting at a given position.

Declaration

Source position: lazutf8.pas line 120

function UTF8StringReplace(

  const S: string;

  const OldPattern: string;

  const NewPattern: string;

  Flags: TReplaceFlags;

  const ALanguage: string = ''

):string;

function UTF8StringReplace(

  const S: string;

  const OldPattern: string;

  const NewPattern: string;

  Flags: TReplaceFlags;

  out Count: Integer;

  const ALanguage: string = ''

):string;

Arguments

S

  

Original UTF-8-encoded values to examine.

OldPattern

  

Pattern to replace in the function.

NewPattern

  

Replacement values for the operation.

Flags

  

Replace options enabled in the function.

ALanguage

  

Language Code used for locale-specific lowercase conversions.

Function result

UTF-8-encoded values after the replace operation.

Arguments

S

  

Original UTF-8-encoded values to examine.

OldPattern

  

Pattern to replace in the function.

NewPattern

  

Replacement values for the operation.

Flags

  

Replace options enabled in the function.

Count

  

Number of times the search pattern was replaced in the string.

ALanguage

  

Language Code used for locale-specific lowercase conversions.

Description

UTF8StringReplace is an overloaded String function which replaces values in a String matching a pattern starting at a given position.

S is the UTF-8-encoded string to update in the function. OldPattern is a pattern with the values to be replaced. NewPattern is the values used to replace the value in OldPattern. Flags contains TReplaceFlags values to use for the operation. ALanguage is the Language Code used for values in function. Count is an output variable used to return the number of replacements performed in the function.

The return value is a UTF-8-encoded string with the updated values following replacement.

UTF8StringReplace uses the same algorithm as the StringReplace function, but uses UTF8LowerCase for case insensitive search (when enabled in Flags).


Version 3.2 Generated 2024-02-25 Home