Rts Property

Sets and returns the state of the request-to-send signal.

Syntax

[Visual Basic]
object.Rts [ = value ]

[C#]
object.Rts [ = value ]

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

Parameters

object

An object expression that evaluates to a PortController object.

value

A boolean value representing the state of the RTS signal.

Return Value

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

Default

False

Remarks

When RTS/CTS handshaking is enabled the RTS line fluctuates between on and off. Reading the Rts property returns the current value of the fluctuating RTS line.

Errors

Attempting to set the RTS signal while RTS/CTS handshaking is enabled is not permitted and will cause PortController to throw a "Unable to set Rts value while RTS/CTS handshaking is enabled" exception.

Example

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

'Get Rts
Dim rts As Boolean
rts = myPortController.Rts


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

// Get Rts
Boolean rts = myPortController.Rts;


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

// Get Rts
Boolean rts = myPortController->Rts;

See Also