Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This routine is available starting with SIL Engineā„¢ 1.0.
Info
titleAvailability
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

fileContains(path_to_file, regex [, charset])

Package

file

Alias

...

Pkg Usage

contains(

...

path_to_file, regex [, charset])

Description

Excerpt
hiddentrue
Returns "true" if the file contains any string that matches the specified regex.

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

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

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.

charset

...

String

No

The 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 Boolean (true/false)

Example

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

...

Note

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

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "file_routines"routine" and space = currentSpace ( )
labelsfilearray_routines