SerialPort.DtrEnable Property (System.IO.Ports)

Switch View

DtrEnable Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SerialPort..::.DtrEnable Property

Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.

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

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(True)> _
Public Property DtrEnable As Boolean

Visual Basic (Usage)

Dim instance As SerialPort
Dim value As Boolean

value = instance.DtrEnable

instance.DtrEnable = value

[BrowsableAttribute(true)]
public bool DtrEnable { get; set; }

Visual C++

[BrowsableAttribute(true)]
public:
property bool DtrEnable {
    bool get ();
    void set (bool value);
}

JScript

public function get DtrEnable () : boolean
public function set DtrEnable (value : boolean)

Property Value

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

Exceptions

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.

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.

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.

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

SerialPort Class

SerialPort Members

System.IO.Ports Namespace