# ReadFile Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------- | | Path : `PathString` |

Full path to the file to be read.


Default: -
Example: folder\file.txt

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Server : `String` |

SMB server address or hostname.


Default: -
Example: 127.0.0.1

| | Share : `String` |

SMB share name to connect to.


Default: -
Example: testshare

| | UserName : `String` |

Username for SMB authentication.

This needs to be of format domain\username


Default: -
Example: WORKGROUP\Administrator

| | 🗝Password : `String` |

Password for the SMB credentials.


Default: -
Example: Password123

| | OperatingSystem : `Os` |

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Possible values:

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.


Default: 2
Example: Linux

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | UseEncoding : `Boolean` |

Whether to attempt decoding the file content to text.

If false, TextContent will be null for all files.


Default: True
Example: true

| | FileEncoding : `FileEncoding` |

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Possible values:

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Encoding for the file content.

By selecting 'Other' you can use any encoding.

Encoding for the file content.

By selecting 'Other' you can use any encoding.


Default: 1
Example: FileEncoding.Default

| | EnableBom : `Boolean` |

Enable BOM (Byte Order Mark) for UTF-8 encoding.


Default: False
Example: false

| | EncodingInString : `String` |

File encoding to be used when FileEncoding is set to 'Other'.

A partial list of possible encodings:


Default: -
Example: ISO-8859-2

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: Custom error message

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates if the task completed successfully.
Example: true

| | Content : `Byte[]` |

File content as a byte array. This property contains the raw bytes of the file, suitable for both text and binary files.
Example: byte\[] { 72, 101, 108, 108, 111 }

| | TextContent : `String` |

File content as a decoded text string (if applicable). This is populated only if the file can be successfully decoded using the specified encoding.
Example: Hello World

| | Path : `PathString` |

The full path of the file that was read.
Example: c:\temp\foo.txt

| | SizeInMegaBytes : `Double` |

Size of the read file in megabytes.
Example: 32

| | CreationTime : `Nullable` |

DateTime when file was created.
Example: 01/31/2023 10:54:17

| | LastWriteTime : `Nullable` |

DateTime for last write time of the file.
Example: 02/06/2023 09:59:13

| | Error : `Error` |

Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.0.0] - 2026-04-08 #### Added * New connection parameters that defined what servers Operating System. * \[Breaking Change] Introduce PathString type that will represent paths with OS specific separators. ### \[1.1.0] - 2025-12-29 #### Changed * Change the default value of Options.UseEncoding to true ### \[1.0.0] - 2025-10-28 #### Added * Initial implementation {% endtab %} {% endtabs %}