N-central Help

Replace Text In File

Replaces text found in a given file with the given string.

Privileges

Normal

Input Parameters

Name Type Required Description
File String Yes The name of the file to be searched.
Search For String Yes The string to search for in the file.
Use Regular Expression Boolean Yes Determines if the search string should be treated as a regular expression.
Replace With String Yes The string to replace the found string.

Output Parameters

Name Type Description
Found String The string that has been found.
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
File String Yes C:\folder1\folder2\file1.txt
Search For String Yes Captain
Use Regular Expression Boolean Yes Optional to use Regular Expressions when searching for the String within the file.
Replace With String Yes Corporal