Describes the console key that was pressed, including the character represented by the console key and the state of the SHIFT, ALT, and CTRL modifier keys.
Assembly: mscorlib (in mscorlib.dll)
Thetype exposes the following members.
|Equals(ConsoleKeyInfo)||Gets a value indicating whether the specified object is equal to the current object.|
|Equals(Object)||Gets a value indicating whether the specified object is equal to the current object. (Overrides ValueType.Equals(Object).)|
|GetHashCode||Returns the hash code for the current object. (Overrides ValueType.GetHashCode.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|ToString||Returns the fully qualified type name of this instance. (Inherited from ValueType.)|
The type is not intended to be created by users. Instead, it is returned to the user in response to calling the Console.ReadKey method.
The object describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The 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.
The following example demonstrates using a object in a read operation.
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
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.