DiscardInBuffer Method

SerialPort.DiscardInBuffer Method

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

Discards data from the serial driver's receive buffer.

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

public void DiscardInBuffer ()
public void DiscardInBuffer ()
public function DiscardInBuffer ()

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 method is equivalent to the following Visual Basic 6.0 code: MSComm1.InBufferCount = 0.

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

Community Additions

ADD
Show:
© 2016 Microsoft