This topic has not yet been rated - Rate this topic

SerialPort.ReadBufferSize Property

.NET Framework 4

Other Versions

Updated: July 2010

Gets or sets the size of the SerialPort input buffer.

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

Syntax

C++

Copy

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

Property Value

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

Exceptions

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

Remarks

The ReadBufferSize property ignores any value smaller than 4096.

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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.