SerialPort.ReadBufferSize Property

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0-rc.2.24473.5

Source:

SerialPort.cs

Gets or sets the size of the SerialPort input buffer.

public:
 property int ReadBufferSize { int get(); void set(int value); };

public int ReadBufferSize { get; set; }

member this.ReadBufferSize : int with get, set

Public Property ReadBufferSize As Integer

Property Value

Int32

The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.

Exceptions

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.