Console.ReadKey Metoda

public:
 static ConsoleKeyInfo ReadKey();

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static ConsoleKeyInfo ReadKey ();

public static ConsoleKeyInfo ReadKey ();

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member ReadKey : unit -> ConsoleKeyInfo

static member ReadKey : unit -> ConsoleKeyInfo

Public Shared Function ReadKey () As ConsoleKeyInfo

Návraty

ConsoleKeyInfo

Objekt, který popisuje ConsoleKey konstantu a znak Unicode, pokud existuje, který odpovídá stisknuté klávese konzoly.An object that describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. ConsoleKeyInfoObjekt také popisuje, v bitové kombinaci ConsoleModifiers hodnot, zda byla současně stisknuta jedna nebo více modifikačních kláves SHIFT, ALT nebo CTRL s klávesou Console.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.

Atributy

UnsupportedOSPlatformAttribute

Výjimky

Příklady

Jedním z nejběžnějších způsobů použití ReadKey() metody je zastavit provádění programu, dokud uživatel nestiskne klávesu a aplikace buď neukončí, nebo zobrazí další okno s informacemi.One of the most common uses of the ReadKey() method is to halt program execution until the user presses a key and the app either terminates or displays an additional window of information. Následující příklad používá ReadKey() metodu pro čekání, až uživatel stiskne klávesu ENTER před ukončením aplikace.The following example uses the ReadKey() method to wait for the user to press the Enter key before terminating the app.

using System;

public class Example
{
   public static void Main()
   {
      DateTime dat = DateTime.Now;
      Console.WriteLine("The time: {0:d} at {0:t}", dat);
      TimeZoneInfo tz = TimeZoneInfo.Local;
      Console.WriteLine("The time zone: {0}\n",
                        tz.IsDaylightSavingTime(dat) ?
                           tz.DaylightName : tz.StandardName);
      Console.Write("Press <Enter> to exit... ");
      while (Console.ReadKey().Key != ConsoleKey.Enter) {}
   }
}
// The example displays output like the following:
//     The time: 11/11/2015 at 4:02 PM:
//     The time zone: Pacific Standard Time

Module Example
   Public Sub Main()
      Dim dat As Date = Date.Now
      Console.WriteLine("The time: {0:d} at {0:t}", dat)
      Dim tz As TimeZoneInfo = TimeZoneInfo.Local
      Console.WriteLine("The time zone: {0}", 
                        If(tz.IsDaylightSavingTime(dat),
                           tz.DaylightName, tz.StandardName))
      Console.WriteLine()
      Console.Write("Press <Enter> to exit... ")
      Do While Console.ReadKey().Key <> ConsoleKey.Enter
      Loop
   End Sub
End Module
' The example displays the following output:
'     The time: 11/11/2015 at 4:02 PM
'     The time zone: Pacific Standard Time

Všimněte si, že toto přetížení ReadKey metody ve výchozím nastavení vypisuje všechny nezobrazitelné klíče, které uživatel stiskne na konzolu.Note that this overload of the ReadKey method by default echoes any displayable keys that the user presses to the console. Chcete-li je potlačit, zavolejte ReadKey metodu s intercept argumentem true .To suppress them, call the ReadKey method with an intercept argument of true.

Následující příklad používá ReadKey() metodu k zobrazení informací o tom, který klíč uživatel stiskne.The following example uses the ReadKey() method to display information about which key the user pressed.

using namespace System;

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();
      Console::Write(" --- You pressed ");
      if((cki.Modifiers & ConsoleModifiers::Alt) != ConsoleModifiers()) Console::Write("ALT+");
      if((cki.Modifiers & ConsoleModifiers::Shift) != ConsoleModifiers()) Console::Write("SHIFT+");
      if((cki.Modifiers & ConsoleModifiers::Control) != ConsoleModifiers()) Console::Write("CTL+");
      Console::WriteLine(cki.Key.ToString());
   } while (cki.Key != ConsoleKey::Escape);
}
// This example displays output similar to the following:
//       Press any combination of CTL, ALT, and SHIFT, and a console key.
//       Press the Escape (Esc) key to quit:
//       
//       a --- You pressed A 
//       k --- You pressed ALT+K 
//       ► --- You pressed CTL+P 
//         --- You pressed RightArrow 
//       R --- You pressed SHIFT+R 
//                --- You pressed CTL+I 
//       j --- You pressed ALT+J 
//       O --- You pressed SHIFT+O 
//       § --- You pressed CTL+U }

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();
         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(cki.Key.ToString());
       } while (cki.Key != ConsoleKey.Escape);
    }
}
// This example displays output similar to the following:
//       Press any combination of CTL, ALT, and SHIFT, and a console key.
//       Press the Escape (Esc) key to quit:
//
//       a --- You pressed A
//       k --- You pressed ALT+K
//       ► --- You pressed CTL+P
//         --- You pressed RightArrow
//       R --- You pressed SHIFT+R
//                --- You pressed CTL+I
//       j --- You pressed ALT+J
//       O --- You pressed SHIFT+O
//       § --- You pressed CTL+U

Class Example
   Public Shared Sub Main()
      Dim cki As ConsoleKeyInfo
      ' 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: " + vbCrLf)
      Do
         cki = Console.ReadKey()
         Console.Write(" --- You pressed ")
         If (cki.Modifiers And ConsoleModifiers.Alt) <> 0 Then Console.Write("ALT+")
         If (cki.Modifiers And ConsoleModifiers.Shift) <> 0 Then Console.Write("SHIFT+")
         If (cki.Modifiers And ConsoleModifiers.Control) <> 0 Then Console.Write("CTL+")
         Console.WriteLine(cki.Key.ToString)
      Loop While cki.Key <> ConsoleKey.Escape
   End Sub 
End Class 
' This example displays output similar to the following:
'       Press any combination of CTL, ALT, and SHIFT, and a console key.
'       Press the Escape (Esc) key to quit:
'       
'       a --- You pressed A 
'       k --- You pressed ALT+K 
'       ► --- You pressed CTL+P 
'         --- You pressed RightArrow 
'       R --- You pressed SHIFT+R 
'                --- You pressed CTL+I 
'       j --- You pressed ALT+J 
'       O --- You pressed SHIFT+O 
'       § --- You pressed CTL+U 

Poznámky

ReadKeyMetoda počká, to znamená, že ve vlákně vydává ReadKey metodu, dokud není stisknut znak nebo klíč funkce.The ReadKey method waits, that is, blocks on the thread issuing the ReadKey method, until a character or function key is pressed. Znak nebo klíč funkce lze stisknout v kombinaci s jednou nebo více modifikátory kláves ALT, CTRL nebo Shift.A character or function key can be pressed in combination with one or more Alt, Ctrl, or Shift modifier keys. Nicméně stisknutí modifikační klávesy sám nezpůsobí, že se ReadKey Metoda vrátí.However, pressing a modifier key by itself will not cause the ReadKey method to return.

V závislosti na aplikaci je vhodné použít ReadKey metodu ve spojení s KeyAvailable vlastností.Depending on your application, you might want to use the ReadKey method in conjunction with the KeyAvailable property.

ReadKeyMetoda čte z klávesnice i v případě, že standardní vstup je přesměrován na soubor s SetIn metodou.The ReadKey method reads from the keyboard even if the standard input is redirected to a file with the SetIn method.

Viz také

• ConsoleKey
• KeyAvailable
• TreatControlCAsInput
• CancelKeyPress

public:
 static ConsoleKeyInfo ReadKey(bool intercept);

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static ConsoleKeyInfo ReadKey (bool intercept);

public static ConsoleKeyInfo ReadKey (bool intercept);

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member ReadKey : bool -> ConsoleKeyInfo

static member ReadKey : bool -> ConsoleKeyInfo

Public Shared Function ReadKey (intercept As Boolean) As ConsoleKeyInfo

Parametry

Návraty

ConsoleKeyInfo

Objekt, který popisuje ConsoleKey konstantu a znak Unicode, pokud existuje, který odpovídá stisknuté klávese konzoly.An object that describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. ConsoleKeyInfoObjekt také popisuje, v bitové kombinaci ConsoleModifiers hodnot, zda byla současně stisknuta jedna nebo více modifikačních kláves SHIFT, ALT nebo CTRL s klávesou Console.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.

Atributy

UnsupportedOSPlatformAttribute

Výjimky

Příklady

Jedním z nejběžnějších způsobů použití ReadKey metody je zastavit provádění programu, dokud uživatel nestiskne klávesu a aplikace buď neukončí, nebo zobrazí další okno s informacemi.One of the most common uses of the ReadKey method is to halt program execution until the user presses a key and the app either terminates or displays an additional window of information. Následující příklad používá ReadKey(Boolean) metodu pro čekání, až uživatel stiskne klávesu ENTER před ukončením aplikace.The following example uses the ReadKey(Boolean) method to wait for the user to press the Enter key before terminating the app. Všimněte si, že pokud uživatel stiskne jakýkoli jiný klíč, nevrátí se do konzoly.Note that, if the user presses any other key, it is not echoed to the console.

using System;

public class Example
{
   public static void Main()
   {
      DateTime dat = DateTime.Now;
      Console.WriteLine("The time: {0:d} at {0:t}", dat);
      TimeZoneInfo tz = TimeZoneInfo.Local;
      Console.WriteLine("The time zone: {0}\n",
                        tz.IsDaylightSavingTime(dat) ?
                           tz.DaylightName : tz.StandardName);
      Console.Write("Press <Enter> to exit... ");
      while (Console.ReadKey(true).Key != ConsoleKey.Enter) {}
   }
}
// The example displays output like the following:
//     The time: 11/11/2015 at 4:02 PM:
//     The time zone: Pacific Standard Time

Module Example
   Public Sub Main()
      Dim dat As Date = Date.Now
      Console.WriteLine("The time: {0:d} at {0:t}", dat)
      Dim tz As TimeZoneInfo = TimeZoneInfo.Local
      Console.WriteLine("The time zone: {0}", 
                        If(tz.IsDaylightSavingTime(dat),
                           tz.DaylightName, tz.StandardName))
      Console.WriteLine()
      Console.Write("Press <Enter> to exit... ")
      Do While Console.ReadKey(True).Key <> ConsoleKey.Enter
      Loop
   End Sub
End Module
' The example displays the following output:
'     The time: 11/11/2015 at 4:02 PM
'     The time zone: Pacific Standard Time

Následující příklad používá ReadKey(Boolean) metodu k zobrazení informací o stisknutí klávesy uživatelem bez navracení tohoto klíče do konzoly.The following example uses the ReadKey(Boolean) method to display information about the key pressed by a user without echoing that key to the console.

using namespace System;

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) != ConsoleModifiers()) Console::Write("ALT+");
      if ((cki.Modifiers & ConsoleModifiers::Shift) != ConsoleModifiers()) Console::Write("SHIFT+");
      if ((cki.Modifiers & ConsoleModifiers::Control) != ConsoleModifiers()) Console::Write("CTL+");
      Console::WriteLine("{0} (character '{1}')", cki.Key, cki.KeyChar);
   } while (cki.Key != ConsoleKey::Escape);
}
// This example displays output similar to the following:
//       Press any combination of CTL, ALT, and SHIFT, and a console key.
//       Press the Escape (Esc) key to quit:
//       
//       You pressed CTL+A (character '☺')
//       You pressed C (character 'c')
//       You pressed CTL+C (character '♥')
//       You pressed K (character 'k')
//       You pressed ALT+I (character 'i')
//       You pressed ALT+U (character 'u')
//       You pressed ALT+SHIFT+H (character 'H')
//       You pressed Escape (character '←')

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);
   }
}
// This example displays output similar to the following:
//       Press any combination of CTL, ALT, and SHIFT, and a console key.
//       Press the Escape (Esc) key to quit:
//
//       You pressed CTL+A (character '☺')
//       You pressed C (character 'c')
//       You pressed CTL+C (character '♥')
//       You pressed K (character 'k')
//       You pressed ALT+I (character 'i')
//       You pressed ALT+U (character 'u')
//       You pressed ALT+SHIFT+H (character 'H')
//       You pressed Escape (character '←')

Class Example
   Public Shared Sub Main()
      Dim cki As ConsoleKeyInfo
      ' 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: " + vbCrLf)
      Do
         cki = Console.ReadKey(True)
         Console.Write("You pressed ")
         If (cki.Modifiers And ConsoleModifiers.Alt) <> 0 Then Console.Write("ALT+")
         If (cki.Modifiers And ConsoleModifiers.Shift) <> 0 Then Console.Write("SHIFT+")
         If (cki.Modifiers And ConsoleModifiers.Control) <> 0 Then Console.Write("CTL+")
         Console.WriteLine("{0} (character '{1}')", cki.Key, cki.KeyChar)
      Loop While cki.Key <> ConsoleKey.Escape
   End Sub
End Class 
' This example displays output similar to the following:
'       Press any combination of CTL, ALT, and SHIFT, and a console key.
'       Press the Escape (Esc) key to quit:
'       
'       You pressed CTL+A (character '☺')
'       You pressed C (character 'c')
'       You pressed CTL+C (character '♥')
'       You pressed K (character 'k')
'       You pressed ALT+I (character 'i')
'       You pressed ALT+U (character 'u')
'       You pressed ALT+SHIFT+H (character 'H')
'       You pressed Escape (character '←')

Poznámky

ReadKeyMetoda počká, to znamená, že ve vlákně vydává ReadKey metodu, dokud není stisknut znak nebo klíč funkce.The ReadKey method waits, that is, blocks on the thread issuing the ReadKey method, until a character or function key is pressed. Znak nebo klíč funkce lze stisknout v kombinaci s jednou nebo více modifikátory kláves ALT, CTRL nebo Shift.A character or function key can be pressed in combination with one or more Alt, Ctrl, or Shift modifier keys. Nicméně stisknutí modifikační klávesy sám nezpůsobí, že se ReadKey Metoda vrátí.However, pressing a modifier key by itself will not cause the ReadKey method to return.

Pokud intercept je parametr true , je Stisknutá klávesa zachycena a není zobrazena v okně konzoly. v opačném případě se zobrazí Stisknutá klávesa.If the intercept parameter is true, the pressed key is intercepted and not displayed in the console window; otherwise, the pressed key is displayed.

V závislosti na aplikaci je vhodné použít ReadKey metodu ve spojení s KeyAvailable vlastností.Depending on your application, you might want to use the ReadKey method in conjunction with the KeyAvailable property.

ReadKeyMetoda čte z klávesnice i v případě, že standardní vstup je přesměrován na soubor s SetIn metodou.The ReadKey method reads from the keyboard even if the standard input is redirected to a file with the SetIn method.

Viz také

• ConsoleKey
• KeyAvailable
• TreatControlCAsInput
• CancelKeyPress