# Read Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Full path of the target file to be read.


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

| | {% endtab %} | | {% tab title="Parameter: 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:

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

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

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

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

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

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


Default: 0
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 %} | | {% tab title="Result: 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

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[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 {% endtab %} {% endtabs %}