C# Console ReadKey(Boolean)

Description

Console ReadKey(Boolean) obtains the next character or function key pressed by the user. The pressed key is optionally displayed in the console window.

Syntax

Console.ReadKey(Boolean) has the following syntax.


[HostProtectionAttribute(SecurityAction.LinkDemand, UI = true)]
public static ConsoleKeyInfo ReadKey(
  bool intercept
)

Parameters

Console.ReadKey(Boolean) has the following parameters.

intercept - Determines whether to display the pressed key in the console window. true to not display the pressed key; otherwise, false.

Returns

Console.ReadKey(Boolean) method returns A ConsoleKeyInfo object that describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The ConsoleKeyInfo object also describes, in a bitwise combination of ConsoleModifiers values, whether one or more Shift, Alt, or Ctrl modifier keys was pressed simultaneously with the console key.

Example

The following example demonstrates the ReadKey method that takes a Boolean parameter.


/*from   w  w  w  . ja va  2  s  . com*/
using System;

class Example 
{
   public static void Main() 
   {
      ConsoleKeyInfo cki;
      // Prevent example from ending if CTL+C is pressed.
      Console.TreatControlCAsInput = true;

      Console.WriteLine("Press any combination of CTL, ALT, and SHIFT, and a console key.");
      Console.WriteLine("Press the Escape (Esc) key to quit: \n");
      do {
         cki = Console.ReadKey(true);
         Console.Write("You pressed ");
         if ((cki.Modifiers & ConsoleModifiers.Alt) != 0) Console.Write("ALT+");
         if ((cki.Modifiers & ConsoleModifiers.Shift) != 0) Console.Write("SHIFT+");
         if ((cki.Modifiers & ConsoleModifiers.Control) != 0) Console.Write("CTL+");
         Console.WriteLine("{0} (character '{1}')", cki.Key, cki.KeyChar);
      } while (cki.Key != ConsoleKey.Escape);
   }
}