This documentation is archived and is not being maintained.

SerialPort.ReadBufferSize Property

Gets or sets the size of the SerialPort input buffer.

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

[BrowsableAttribute(true)]
public int ReadBufferSize { get; set; }

Property Value

Type: System.Int32
The buffer size. The default value is 4096.

ExceptionCondition
ArgumentOutOfRangeException

The ReadBufferSize value set is less than or equal to zero.

InvalidOperationException

The ReadBufferSize property was set while the stream was open.

IOException

The ReadBufferSize property was set to an odd integer value.

The ReadBufferSize property ignores any value smaller than 4096.

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 Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: On Windows CE, the buffer sizes passed are only recommendations, not requirements of the serial driver. The serial driver may ignore the recommended buffer sizes.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: