SerialPort.CtsHolding Property

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0-rc.2.24473.5

Source:

SerialPort.cs

Gets the state of the Clear-to-Send line.

public:
 property bool CtsHolding { bool get(); };

public bool CtsHolding { get; }

member this.CtsHolding : bool

Public ReadOnly Property CtsHolding As Boolean

Property Value

Boolean

true if the Clear-to-Send line is detected; otherwise, false.

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.

InvalidOperationException

The stream is closed. This can occur because the Open() method has not been called or the Close() method has been called.

Remarks

The Clear-to-Send (CTS) line is used in Request to Send/Clear to Send (RTS/CTS) hardware handshaking. The CTS line is queried by a port before data is sent.