TElSftpClient.LocalNewLineConvention property

TElSftpClient.LocalNewLineConvention

The character string used for the end of line (EOL) indication on the local machine.

Declaration

[C#]
byte[] LocalNewLineConvention;

[VB.NET]
Property LocalNewLineConvention As Byte()

[Pascal]
property LocalNewLineConvention : ByteArray;

[C++]
void get_LocalNewLineConvention(std::vector<uint8_t> &OutResult);
void set_LocalNewLineConvention(const std::vector<uint8_t> &Value);

[PHP]
string get_LocalNewLineConvention()
void set_LocalNewLineConvention(array of byte|string|NULL $Value)

[Java]
byte[] getLocalNewLineConvention();
void setLocalNewLineConvention(byte[] Value);

Description

This property contains character string for end of line indication used on the local machine. Usually its value is one of 0x0d, 0x0d 0x0a, 0x0a 0x0d, or 0x0a, but it can be different on some servers.

During file download all NewLineConvention line endings are converted to LocalNewLineConvention endings, and vice versa, all LocalNewLineConvention line endings are converted to NewLineConvention line endings during file upload. Both properties apply to text file transfers only.

SecureBlackbox provides emulation of ASCII transfer for SFTP protocols which do not support ASCII transfers natively. For protocol versions 0, 1, 2, and 3, this property may be used to specify server newline convention. Setting this property for protocol versions 4 and higher makes no sense.