Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Console::KeyAvailable Property

 

Gets a value indicating whether a key press is available in the input stream.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

public:
property bool KeyAvailable {
	[HostProtectionAttribute(SecurityAction::LinkDemand, UI = true)]
	static bool get();
}

Property Value

Type: System::Boolean

true if a key press is available; otherwise, false.

Exception Condition
IOException

An I/O error occurred.

InvalidOperationException

Standard input is redirected to a file instead of the keyboard.

The property value is returned immediately; that is, the KeyAvailable property does not block input until a key press is available.

Use the KeyAvailable property in conjunction with only the ReadKey method, not the Read or ReadLine methods.

The following example demonstrates how to use the KeyAvailable property to create a loop that runs until a key is pressed.

using namespace System;
using namespace System::Threading;
int main()
{
   ConsoleKeyInfo cki;
   do
   {
      Console::WriteLine( "\nPress a key to display; press the 'x' key to quit." );

      // Your code could perform some useful task in the following loop. However, 
      // for the sake of this example we'll merely pause for a quarter second.
      while ( Console::KeyAvailable == false )
            Thread::Sleep( 250 );
      cki = Console::ReadKey( true );
      Console::WriteLine( "You pressed the '{0}' key.", cki.Key );
   }
   while ( cki.Key != ConsoleKey::X );
}

/*
This example produces results similar to the following:

Press a key to display; press the 'x' key to quit.
You pressed the 'H' key.

Press a key to display; press the 'x' key to quit.
You pressed the 'E' key.

Press a key to display; press the 'x' key to quit.
You pressed the 'PageUp' key.

Press a key to display; press the 'x' key to quit.
You pressed the 'DownArrow' key.

Press a key to display; press the 'x' key to quit.
You pressed the 'X' key.
*/

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft