====== strreplace ======

===== Description =====

Replace a substring of text within a string with another substring.

===== Function prototype =====

<code>
string strreplace <string:Text> <string:Old> <string:New>
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //Text//  |  string  | A string, a substring of which is to be replaced. |
|  //Old//  |  string  | A substring of //Text// that is to be replaced.  |
|  //New//  |  string  | A string that is to replace //Old// within //Text//.  |

===== Return value =====

A string containing //Text// with all instances of //Old// replaced by //New//.

===== Example =====

<code>
// replace "test" in "this is a test" with "awesome"

echo <strreplace "This is a test" "test" "awesome">
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
This is awesome
</file>

===== Comments =====

None.

===== See also =====

  * [[plugins:general:zeoscript:reference:functions:strfind]]