Handshake Enumeration

Specifies the control protocol used in establishing a serial port communication for a SerialPort object.

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

'Declaration
Public Enumeration Handshake
'Usage
Dim instance As Handshake

public enum Handshake
public enum Handshake

 Member nameDescription
Supported by the .NET Compact FrameworkNoneNo control is used for the handshake. 
Supported by the .NET Compact FrameworkRequestToSendRequest-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. 
Supported by the .NET Compact FrameworkRequestToSendXOnXOffBoth the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used. 
Supported by the .NET Compact FrameworkXOnXOffThe 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. 

This enumeration is used with the Handshake property.

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("Stop Bits({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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show: