This documentation is archived and is not being maintained.

SerialPort.BreakState Property

Gets or sets the break signal state.

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

public bool BreakState { get; set; }
/** @property */
public boolean get_BreakState ()

/** @property */
public void set_BreakState (boolean value)

public function get BreakState () : boolean

public function set BreakState (value : boolean)

Not applicable.

Property Value

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

Exception typeCondition

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.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0
Show: