SerialPort.DiscardNull Property

Reference

Definition

Namespace:: System.IO.Ports

Assembly:: System.IO.Ports.dll

Assembly:: System.dll

Package:: System.IO.Ports v10.0.0-preview.1.25080.5

Source:: SerialPort.cs

Source:: SerialPort.cs

Source:: SerialPort.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.

public:
 property bool DiscardNull { bool get(); void set(bool value); };

public bool DiscardNull { get; set; }

[System.ComponentModel.Browsable(true)]
public bool DiscardNull { get; set; }

member this.DiscardNull : bool with get, set

[<System.ComponentModel.Browsable(true)>]
member this.DiscardNull : bool with get, set

Public Property DiscardNull As Boolean

Property Value

Boolean

true if null bytes are ignored; otherwise false. The default is false.

Attributes: BrowsableAttribute

Exceptions

IOException

The port is in an invalid state.

-or-

An attempt to set the state of the underlying port failed. For example, the parameters passed from this SerialPort object were invalid.

InvalidOperationException

The stream is closed. This can occur because the Open() method has not been called or the Close() method has been called.

Remarks

This value should normally be set to false, especially for binary transmissions. Setting this property to true can cause unexpected results for UTF32- and UTF16-encoded bytes.

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via