SerialPort.RtsEnable Property

Reference

Definition

Namespace:: System.IO.Ports

Assembly:: System.IO.Ports.dll

Assembly:: System.dll

Package:: System.IO.Ports v6.0.0

Package:: System.IO.Ports v7.0.0

Package:: System.IO.Ports v8.0.0

Package:: System.IO.Ports v9.0.0-preview.2.24128.5

Source:: SerialPort.cs

Source:: SerialPort.cs

Source:: SerialPort.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.

public:
 property bool RtsEnable { bool get(); void set(bool value); };

public bool RtsEnable { get; set; }

[System.ComponentModel.Browsable(true)]
public bool RtsEnable { get; set; }

member this.RtsEnable : bool with get, set

[<System.ComponentModel.Browsable(true)>]
member this.RtsEnable : bool with get, set

Public Property RtsEnable As Boolean

Property Value

Boolean

true to enable Request to Transmit (RTS); otherwise, false. The default is false.

Attributes: BrowsableAttribute

Exceptions

InvalidOperationException

The value of the RtsEnable property was set or retrieved while the Handshake property is set to the RequestToSend value or the RequestToSendXOnXOff value.

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.

Remarks

The Request to Transmit (RTS) signal is typically used in Request to Send/Clear to Send (RTS/CTS) hardware handshaking.

Applies to