Dtr Property

Sets and returns the state of the data-terminal-ready signal.

Syntax

[Visual Basic]
object.Dtr [ = value ]

[C#]
object.Dtr [ = value ]

[C++]
object->Dtr [ = value ]

Parameters

object

An object expression that evaluates to a PortController object.

value

A boolean value representing the state of the DTR signal.

Return Value

The boolean value true if the DTR signal is on, false otherwise.

Default

False

Remarks

When DTR/DSR handshaking is enabled the DTR line fluctuates between on and off. Reading the Dtr property returns the current value of the fluctuating DTR line.

Errors

Attempting to set the DTR signal while DTR/DSR handshaking is enabled is not permitted and will cause PortController to throw a "Unable to set Dtr value while DTR/DSR handshaking is enabled" exception.

Example

[Visual Basic]
'Set Dtr
myPortController.Dtr = True

'Get Dtr
Dim dtr As Boolean
dtr = myPortController.Dtr


[C#]
// Set Dtr
myPortController.Dtr = true;

// Get Dtr
Boolean bDtr = myPortController.Dtr;


[C++]
// Set Dtr
myPortController->Dtr = true;

// Get Dtr
Boolean bDtr = myPortController->Dtr;

See Also