SerialDevice.Handshake Property

Definition

Namespace:

Windows.Devices.SerialCommunication

Gets or sets the handshaking protocol for flow control.

public:
 property SerialHandshake Handshake { SerialHandshake get(); void set(SerialHandshake value); };

SerialHandshake Handshake();

void Handshake(SerialHandshake value);

public SerialHandshake Handshake { get; set; }

var serialHandshake = serialDevice.handshake;
serialDevice.handshake = serialHandshake;

Public Property Handshake As SerialHandshake

Property Value

SerialHandshake

One of the values defined in SerialHandshake enumeration.

Remarks

The handshaking protocol is used by the serial port to establish flow control between the port and the connected device. There are two types of control protocol.

• Hardware control: The Request-to-Send (RTS) line is set to false when the receiver's buffer is full. This indicates to the sender that it must stop sending data. When the buffer is able to hold data, the RTS line is set to true that indicates to the send that it is now ready to receive data again.
• Software control: The receiver sends an Xoff control code to the sender to stop transmission of data. When the receiver is ready, it sends the Xon code and the sender resumes data transmission. The SerialHandshake enumeration defines the preceding control type values.

You can set hardware, software, or both types of control protocol.