This documentation is archived and is not being maintained.

SerialPort.DiscardNull Property

Note: This property is new in the .NET Framework version 2.0.

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

Namespace: System.IO.Ports
Assembly: System (in system.dll)

public bool DiscardNull { get; set; }
/** @property */
public boolean get_DiscardNull ()

/** @property */
public void set_DiscardNull (boolean value)

public function get DiscardNull () : boolean

public function set DiscardNull (value : boolean)

Property Value

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

Exception typeCondition

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.

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.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0
Show: