This documentation is archived and is not being maintained.

SerialPort.BytesToRead Property

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

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

public int BytesToRead { get; }
/** @property */
public int get_BytesToRead ()

public function get BytesToRead () : int

Not applicable.

Property Value

The number of bytes of data in the receive buffer.

Exception typeCondition

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.

NoteNote:

The BytesToRead property can return a value larger than the ReadBufferSize property because the ReadBufferSize property represents only the Windows-created buffer while the BytesToRead property represents the SerialPort buffer in addition to the Windows-created buffer.

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0
Show: