Export (0) Print
Expand All

Handshake Enumeration

Note: This enumeration is new in the .NET Framework version 2.0.

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

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

public enum 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 static Handshake SetPortHandshake(Handshake defaultPortHandshake)
{
    string handshake;

    Console.WriteLine("Available Handshake options:");
    foreach (string s in Enum.GetNames(typeof(Handshake)))
    {
        Console.WriteLine("   {0}", s);
    }

    Console.Write("Stop Bits({0}):", defaultPortHandshake.ToString());
    handshake = Console.ReadLine();

    if (handshake == "")
    {
        handshake = defaultPortHandshake.ToString();
    }

    return (Handshake)Enum.Parse(typeof(Handshake), handshake);
}

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft