SFTP

Frends.SFTP.WriteFile / 3.0.0

Summary

Creates a file on an SFTP server directly from content held in the Process, with no local file involved.

Typical use — small generated files such as trigger or manifest files

Details

Frends version
5.5 and newer
Agent
Crossplatform
Target framework
net6.0

Source transfer options

Name Type Default Example Description
Path String / /destination

Full path of the target file to be written.

Content String This is test file

Text content to be written.

FileEncoding FileEncoding ANSI FileEncoding.ANSI

If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

Possible values:

  • UTF8: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • ANSI: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • ASCII: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • WINDOWS1252: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • Unicode: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • Other: Other enables users to add other encoding options as string.

EnableBom Boolean False true

Additional option for UTF-8 encoding to enable bom.

EncodingInString String utf-8

File encoding to be used. Encoding don't support any unicode encoding. It only support the code page encodings. A partial list of possible encodings: https://en.wikipedia.org/wiki/Windows_code_page#List.

WriteBehaviour WriteOperation WriteOperation.Append

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

Possible values:

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

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

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

AddNewLine Boolean False true

If enabled new line is added to the existing file before appending the content.

An unhandled error has occurred. Reload 🗙