SerialPort.BreakState Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the break signal state.

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

[<BrowsableAttribute(false)>]
member BreakState : bool with get, set

Property Value

Type: System.Boolean

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

Exception Condition
IOException

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.

InvalidOperationException

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

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.

.NET Framework
Available since 2.0
Return to top
Show: