SerialPort.BytesToRead Property

Reference

Definition

Namespace:: System.IO.Ports

Assembly:: System.IO.Ports.dll

Assembly:: System.dll

Package:: System.IO.Ports v10.0.0-preview.1.25080.5

Source:: SerialPort.cs

Source:: SerialPort.cs

Source:: SerialPort.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the number of bytes of data in the receive buffer.

public:
 property int BytesToRead { int get(); };

public int BytesToRead { get; }

[System.ComponentModel.Browsable(false)]
public int BytesToRead { get; }

member this.BytesToRead : int

[<System.ComponentModel.Browsable(false)>]
member this.BytesToRead : int

Public ReadOnly Property BytesToRead As Integer

Property Value

Int32

The number of bytes of data in the receive buffer.

Attributes: BrowsableAttribute

Exceptions

InvalidOperationException

The port is not open.

Remarks

The receive buffer includes the serial driver's receive buffer as well as internal buffering in the SerialPort object itself.

Because the BytesToRead property represents both the SerialPort buffer and the Windows-created buffer, it can return a greater value than the ReadBufferSize property, which represents only the Windows-created buffer.

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via