1 out of 2 rated this helpful - Rate this topic

SerialPort.DiscardInBuffer Method

.NET Framework 4.5

Discards data from the serial driver's receive buffer.

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

public void DiscardInBuffer()

Exceptions

Exception	Condition
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.

Exception

Condition

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

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

SerialPort Class

System.IO.Ports Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)