SerialPort.BreakState Property

Definition

Gets or sets the break signal state.

public:
 property bool BreakState { bool get(); void set(bool value); };
public bool BreakState { get; set; }
[System.ComponentModel.Browsable(false)]
public bool BreakState { get; set; }
member this.BreakState : bool with get, set
[<System.ComponentModel.Browsable(false)>]
member this.BreakState : bool with get, set
Public Property BreakState As Boolean

Property Value

true if the port is in a break state; otherwise, false.

Attributes

Exceptions

The port is in an invalid state.

-or-

An attempt to set the state of the underlying port failed. For example, the parameters passed from this SerialPort object were invalid.

The stream is closed. This can occur because the Open() method has not been called or the Close() method has been called.

Remarks

The break signal state occurs when a transmission is suspended and the line is placed in a break state (all low, no stop bit) until released. To enter a break state, set this property to true. If the port is already in a break state, setting this property again to true does not result in an exception. It is not possible to write to the SerialPort object while BreakState is true.

Applies to