SerialPort.ReceivedBytesThreshold Property (System.IO.Ports)

Microsoft Developer Network

ReceivedBytesThreshold Property

.NET Framework Class Library

SerialPort..::.ReceivedBytesThreshold Property

Gets or sets the number of bytes in the internal input buffer before a DataReceived event occurs.

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

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(True)> _
Public Property ReceivedBytesThreshold As Integer

Visual Basic (Usage)

Dim instance As SerialPort
Dim value As Integer

value = instance.ReceivedBytesThreshold

instance.ReceivedBytesThreshold = value

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

Visual C++

[BrowsableAttribute(true)]
public:
property int ReceivedBytesThreshold {
    int get ();
    void set (int value);
}

JScript

public function get ReceivedBytesThreshold () : int
public function set ReceivedBytesThreshold (value : int)

Property Value

Type: System..::.Int32
The number of bytes in the internal input buffer before a DataReceived event is fired. The default is 1.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The ReceivedBytesThreshold value is less than or equal to zero.

Remarks

The DataReceived event may also be raised if an End of File byte is received, regardless of the number of bytes in the internal input buffer and the value of the ReceivedBytesThreshold property.

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

SerialPort Class

SerialPort Members

System.IO.Ports Namespace