SerialPort.DtrEnable Property

Reference

Definition

Namespace:: System.IO.Ports

Assembly:: System.IO.Ports.dll

Assembly:: System.dll

Package:: System.IO.Ports v9.0.0

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 that enables the Data Terminal Ready (DTR) signal during serial communication.

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

public bool DtrEnable { get; set; }

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

member this.DtrEnable : bool with get, set

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

Public Property DtrEnable As Boolean

Property Value

Boolean

true to enable Data Terminal Ready (DTR); otherwise, false. The default is false.

Attributes: BrowsableAttribute

Exceptions

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

Data Terminal Ready (DTR) is typically enabled during XON/XOFF software handshaking and Request to Send/Clear to Send (RTS/CTS) hardware handshaking, and modem communications.

Applies to

Jaa