> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/files/read.md). # Read Reads a file from directory. Task version: 1.2.0 Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Full path of the target file to be read.


Default: -
Example: c:\temp\foo.txt

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

If set, allows you to give the user credentials to use to delete files on remote hosts.

If not set, the agent service user credentials will be used.

Note: This feature is only possible with Windows agents.


Default: False
Example: true

| | UserName : `String` |

This needs to be of format domain\username


Default: "domain\username"
Example: domain\username

| | 🗝Password : `String` |

Password for the used credentials.


Default: -
Example: testpwd

| | FileEncoding : `FileEncoding` |

Encoding for the written content. By selecting 'Other' you can use any encoding.

Possible values:


Default: UTF8
Example: FileEncoding.UTF8

| | EnableBom : `Boolean` |

Enable BOM for UTF-8


Default: False
Example: true

| | EncodingInString : `String` |

File encoding to be used. A partial list of possible encodings:


Default: -
Example: ISO-8859-2

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | -------------------------- | --------------------------------------------------------------------------------------------- | | Content : `String` |

File content.
Example: This is a test file.

| | Path : `String` |

Full path to the file.
Example: c:\temp\foo.txt

| | SizeInMegaBytes : `Double` |

Size of the written file in mega bytes.
Example: 32

| | SizeInKiloBytes : `Double` |

Size of the written file in kilo bytes.
Example: 32

| | SizeInBytes : `Double` |

Size of the written file in bytes.
Example: 32

| | CreationTime : `DateTime` |

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

| | LastWriteTime : `DateTime` |

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

| ## Task Changelog Changelog for Task Frends.Files.Read. ### \[1.2.0] - 2025-03-19 #### Changed * Update packaged: Microsoft.Extensions.FileSystemGlobbing 7.0.0 -> 9.0.3 System.ComponentModel.Annotations 4.7.0 -> 5.0.0 System.DirectoryServices 7.0.0 -> 8.0.0 coverlet.collector 3.1.0 -> 6.0.4 Microsoft.NET.Test.Sdk 16.6.1 -> 17.13.0 MSTest.TestAdapter 2.2.7 -> 3.8.3 MSTest.TestFramework 2.2.8 -> 3.8.3 nunit 3.12.0 -> 4.3.2 NUnit3TestAdapter 3.17.0 -> 5.0.0 ### \[1.1.0] - 2024-10-14 #### Fixed * Fixed documentation for Path parameter. #### Added * Added Windows1252 encoding to the FileEncoding enum. * Added different sizes to the Task result. ### \[1.0.0] - 2023-02-28 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.frends.com/tasks/tasks/files/read.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.