Edit

SerialPort.DiscardInBuffer Method

  • Reference

Definition

Namespace:
System.IO.Ports
Assembly:
System.IO.Ports.dll
Assembly:
System.dll
Package:
System.IO.Ports v6.0.0
Package:
System.IO.Ports v7.0.0
Package:
System.IO.Ports v8.0.0
Package:
System.IO.Ports v9.0.0-preview.2.24128.5
Source:
SerialPort.cs
Source:
SerialPort.cs
Source:
SerialPort.cs

Discards data from the serial driver's receive buffer.

public:
 void DiscardInBuffer();
public void DiscardInBuffer ();
member this.DiscardInBuffer : unit -> unit
Public Sub DiscardInBuffer ()

Exceptions

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.

Applies to