This documentation is archived and is not being maintained.

_getche, _getwche

Gets a character from the console with echo.

Important note Important

This API cannot be used in applications that execute in the Windows Runtime. For more information, see CRT functions not supported with /ZW.

int _getche( void );
wint_t _getwche( void );

Returns the character read. There is no error return.

The _getche and_getwche functions read a single character from the console with echo, meaning that the character is displayed at the console. None of these functions can be used to read CTRL+C. When reading a function key or an arrow key, each function must be called twice; the first call returns 0 or 0xE0, and the second call returns the actual key code.

These functions lock the calling thread and are therefore thread-safe. For non-locking versions, see _getche_nolock, _getwche_nolock.

Generic-Text Routine Mappings

Tchar.h routine

_UNICODE and _MBCS not defined

_MBCS defined

_UNICODE defined






Required header




<conio.h> or <wchar.h>

For more compatibility information, see Compatibility in the Introduction.

// crt_getche.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: " );
      ch = _getche();
      ch = toupper( ch );
   } while( ch != 'Y' );

   _putch( ch );
   _putch( '\r' );    // Carriage return
   _putch( '\n' );    // Line feed     
Type 'Y' when finished typing keys: Y

Not applicable. To call the standard C function, use PInvoke. For more information, see Platform Invoke Examples.