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

Source directory.


Default: -
Example: This is test content

| | Path : `String` |

Full path of the target file to be written


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

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

Sets a value indicating whether remote connection is used.

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` |

Sets username. This needs to be of format domain\username.


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

| | 🗝Password : `String` |

Sets password for the used credentials.


Default: -
Example: testpwd

| | FileEncoding : `FileEncoding` |

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

Possible values:

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

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

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

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

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

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


Default: 0
Example: FileEncoding.UTF8

| | EnableBom : `Boolean` |

Sets a value indicating whether enablation BOM for UTF-8.


Default: False
Example: true

| | EncodingInString : `String` |

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


Default: -
Example: ISO-8859-2

| | WriteBehaviour : `WriteBehaviour` |

Sets write behaviour.

How the file write should work if a file with the new name already exists.

Possible values:

Sets write behaviour.

How the file write should work if a file with the new name already exists.

Sets write behaviour.

How the file write should work if a file with the new name already exists.

Sets write behaviour.

How the file write should work if a file with the new name already exists.


Default: 2
Example: WriteBehaviour.Throw

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

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[1.4.0] - 2025-11-04 #### Fixed * Returning correct file size ### \[1.3.0] - 2025-06-05 #### Fixed * Resolve issue with an unsupported library in .net 6. #### Changed * Downgrade package System.Text.Encoding.CodePages from 9.0.3 to 8.0.0 * Remove unused package Microsoft.Extensions.FileSystemGlobbing ### \[1.2.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 System.Text.Encoding.CodePages 8.0.0 -> 9.0.3 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 * Renamed ANSI encoding to Default. #### Added * Added result properties SizeInKiloBytes and SizeInBytes. ### \[1.0.1] - 2024-02-27 #### Added * Windows-1252 added to "Encoding" options. ### \[1.0.0] - 2023-02-15 #### Added * Initial implementation {% endtab %} {% endtabs %}