Skip to content

CFE-4694: Updated docs for string_replace #3724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
victormlg wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −4
Open

CFE-4694: Updated docs for string_replace #3724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions content/reference/functions/string_replace.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ aliases:
- "/reference-functions-string_replace.html"
---

{{< CFEngine_function_prototype(string, match, replacement) >}}
{{< CFEngine_function_prototype(string, match, replacement, option) >}}

**Description:** In a given string, replaces a substring with another string.

{{< CFEngine_function_attributes(string, match, replacement) >}}
**Description:** Replaces a substring, or a list of substrings, within a given string with a specified replacement string or list of replacement strings.
{{< CFEngine_function_attributes(string, match, replacement, option) >}}

Reads a string from left to right, replacing the occurences of the second
argument with the third argument in order.

By default, the `option` parameter is set to `"strings"`, meaning the function expects `match` and `replacement` to be single strings. To use lists of strings instead, set option to `"lists"`. Lists can be passed as variables or inline JSON. However, their lengths must match exactly, as substitutions are applied pairwise. Note that mixing single string and list arguments is not supported.

All characters in the string to replace in, the substring to match for and the
replacement are read literally. This means that `.`, `*`, `\` and similar
characters will be read and replaced as they are. If you are looking for more
Expand Down
Loading