SerialPort.CDHolding Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the state of the Carrier Detect line for the port.

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

[<BrowsableAttribute(false)>]
member CDHolding : bool with get

Property Value

Type: System.Boolean

true if the carrier is detected; otherwise, false.

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.

InvalidOperationException

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

This property can be used to monitor the state of the carrier detection line for a port. No carrier usually indicates that the receiver has hung up and the carrier has been dropped.

.NET Framework
Available since 2.0
Return to top
Show: