Handshake Enumeration
Specifies the control protocol used in establishing a serial port communication for a SerialPort object.
Assembly: System (in System.dll)
| Member name | Description | |
|---|---|---|
![]() | None | No control is used for the handshake. |
![]() | XOnXOff | The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls. |
![]() | RequestToSend | Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to false. The RTS line will be set to true when more room becomes available in the input buffer. |
![]() | RequestToSendXOnXOff | Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used. |
The following code example displays the possible values of the Handshake enumeration to the console, then prompts the user to choose one. This code example is part of a larger code example provided for the SerialPort class.
Public Shared Function SetPortHandshake(ByVal defaultPortHandshake As Handshake) As Handshake Dim newHandshake As String Console.WriteLine("Available Handshake options:") Dim s As String For Each s In [Enum].GetNames(GetType(Handshake)) Console.WriteLine(" {0}", s) Next s Console.Write("Handshake({0}):", defaultPortHandshake.ToString()) newHandshake = Console.ReadLine() If newHandshake = "" Then newHandshake = defaultPortHandshake.ToString() End If Return CType([Enum].Parse(GetType(Handshake), newHandshake), Handshake) End Function
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
