# ReadBytes

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.Files/tree/main/Frends.Files.ReadBytes>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name            | Description                                                                                                                |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Path : `String` | <p>Full path of the target file to be read.</p><p><br>Default: <code>-</code><br>Example: <code>c:\temp\foo.txt</code></p> |
| {% endtab %}    |                                                                                                                            |

{% tab title="Parameter: Options" %}

| Name                                                    | Description                                                                                                                                                                                                                                                                                          |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| UseGivenUserCredentialsForRemoteConnections : `Boolean` | <p>If set, allows you to give the user credentials to use to delete files on remote hosts.</p><p>If not set, the agent service user credentials will be used.</p><p>Note: This feature is only possible with Windows agents.</p><p><br>Default: <code>False</code><br>Example: <code>true</code></p> |
| UserName : `String`                                     | <p>This needs to be of format domain\username</p><p><br>Default: <code>"domain\username"</code><br>Example: <code>domain\username</code></p>                                                                                                                                                         |
| 🗝Password : `String`                                   | <p>Password for the used credentials.</p><p><br>Default: <code>-</code><br>Example: <code>testpwd</code></p>                                                                                                                                                                                         |
| {% endtab %}                                            |                                                                                                                                                                                                                                                                                                      |

{% tab title="Result: Result" %}

| Name                       | Description                                                                                   |
| -------------------------- | --------------------------------------------------------------------------------------------- |
| ContentBytes : `Byte[]`    | <p>File content.<br>Example: <code>This is a test file.</code></p>                            |
| Path : `String`            | <p>Full path to the file.<br>Example: <code>c:\temp\foo.txt</code></p>                        |
| SizeInMegaBytes : `Double` | <p>Size of the written file in mega bytes.<br>Example: <code>32</code></p>                    |
| CreationTime : `DateTime`  | <p>DateTime when file was created.<br>Example: <code>01/31/2023 10:54:17</code></p>           |
| LastWriteTime : `DateTime` | <p>DateTime for last write time of the file.<br>Example: <code>02/06/2023 09:59:13</code></p> |
| {% endtab %}               |                                                                                               |

{% tab title="Changelog" %}

## Changelog

### \[1.1.0] - 2025-03-19

#### Changed

* Update packages: 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.0.0] - 2023-04-20

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}