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, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.

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.

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.

.NET Framework
Available since 2.0
Return to top
Show: