Export (0) Print
Expand All

SerialPort.DiscardInBuffer Method

Discards data from the serial driver's receive buffer.

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

member DiscardInBuffer : unit -> unit

ExceptionCondition
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 method is equivalent to the following Visual Basic code: MSComm1.InBufferCount = 0. It clears the receive buffer, but does not affect the transmit buffer.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft