SerialPort.DiscardInBuffer Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Discards data from the serial driver's receive buffer.

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

public void DiscardInBuffer()

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.

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
Available since 2.0
Return to top
Show: