SerialPort.NewLine Property

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0

Source:

SerialPort.cs

Gets or sets the value used to interpret the end of a call to the ReadLine() and WriteLine(String) methods.

public:
 property System::String ^ NewLine { System::String ^ get(); void set(System::String ^ value); };

public string NewLine { get; set; }

member this.NewLine : string with get, set

Public Property NewLine As String

Property Value

String

A value that represents the end of a line. The default is a line feed ("\n" in C# or vbLf in Visual Basic).

Exceptions

ArgumentException

The property value is empty.

ArgumentNullException

The property value is null.

Remarks

This property determines what value (byte) defines the end of a line for the ReadLine and WriteLine methods. By default the end-of-line value is a line feed character (\n in C#, Constants.vbLf in Visual Basic). You would change this to a different value if the particular serial device you're working with uses a different value for the same purpose.