SerialPort.CtsHolding Property

Definition

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 the state of the Clear-to-Send line.

C#
public bool CtsHolding { get; }
C#
[System.ComponentModel.Browsable(false)]
public bool CtsHolding { get; }

Property Value

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

Attributes

Exceptions

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.

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.

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided)