Export (0) Print
Expand All

SerialPort.BytesToRead Property

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

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

[BrowsableAttribute(false)]
public int BytesToRead { get; }

Property Value

Type: System.Int32
The number of bytes of data in the receive buffer.

ExceptionCondition
IOException

The port is in an invalid state.

InvalidOperationException

The stream is closed. This can occur because the Open method has not been called or the Close method has been called.

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.

.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.

Community Additions

ADD
Show:
© 2014 Microsoft