This documentation is archived and is not being maintained.

SerialPort.DiscardInBuffer Method

Discards data from the serial driver's receive buffer.

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

public void DiscardInBuffer()

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 6.0 code: MSComm1.InBufferCount = 0.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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