Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 1.0.

Syntax

fileContains(path_to_file, regex [, charset])

Description

Returns "true" if the file contains any string that matches the specified regex. If the regex contains a backslash replace it with two backslashes otherwise you will get a syntax error.

Parameters

Parameter name

Type

Required

Description

path_to_file

string

Yes

Specifies the file name.

regex

string

Yes

Specifies search string into the file path_to_file.

charsetstringNoThe charset, optional. If you need to open a text file and the encoding is different, use a value that matches a valid charset name. Available starting with katl-commons 4.0.0.

Return type

boolean (true/false)

Example

//This will match any "com.keplerrominfo.jira" occurence in myfile.txt.
fileContains("C:/myfile.txt","com\\.keplerrominfo.jira");

Notes

It is recommended that you use absolute file paths with forward slashes ( / ).

See also