_getch, _getwch

Gets a character from the console without echo.

Syntax

int _getch( void );
wint_t _getwch( void );

Return value

Returns the character read. There's no error return.

Remarks

The _getch and _getwch functions read a single character from the console without echoing the character. To read a function key or arrow key, each function must be called twice. The first call returns 0 or 0xE0. The second call returns the key scan code.

These functions lock the calling thread and so are thread-safe. For non-locking versions, see _getch_nolock, _getwch_nolock.

By default, this function's global state is scoped to the application. To change this behavior, see Global state in the CRT.

Generic-text routine mappings

Requirements

For more compatibility information, see Compatibility.

Example

// crt_getch.c
// compile with: /c
// This program reads characters from
// the keyboard until it receives a 'Y' or 'y'.

#include <conio.h>
#include <ctype.h>

int main( void )
{
   int ch;

   _cputs( "Type 'Y' when finished typing keys: " );
   do
   {
      ch = _getch();
      ch = toupper( ch );
   } while( ch != 'Y' );

   _putch( ch );
   _putch( '\r' );    // Carriage return
   _putch( '\n' );    // Line feed
}

abcdefy

Type 'Y' when finished typing keys: Y

See also

Console and port I/O
_getche, _getwche
_cgets, _cgetws
getc, getwc
_ungetch, _ungetwch, _ungetch_nolock, _ungetwch_nolock