---
title: "fileContains"
canonical: "https://support.appfire.com/space/PSCONF/15303337/fileContains"
format: markdown
---
> Macro (aura-html)

> Macro (table-plus)
> 
> |  |  |  |  |
> | --- | --- | --- | --- |
> | **Syntax** | fileContains(path_to_file, regex [, charset]) | **Package** | file |
> | **Alias** |  | **Pkg Usage** | contains(path_to_file, regex [, charset]) |

## Description

> Macro (excerpt)
> 
> 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

> Macro (table-plus)
> 
> | 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 (true/false)**

## Example

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

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

## See also

> Macro (contentbylabel)