Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleAvailability

This routine is available since starting with katl-commons 1.0.

Syntax

...

fileContains(path_to_file, regex [, charset])

Description

...

Excerpt

Returns true if the file contains any string that matches the specified regex. If the regex contains a backslash, please replace it with two backslashes, or else 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 here a value that matches a valid charset name. (Available since katl-commons 4.0.0)

Return type

...

boolean (true/false)

Example

...

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

Notes

...

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

See also

...

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "file_routines"
labelsfile_routines