_getch_nolock, _getwch_nolock

Article
06/05/2017

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at _getch_nolock, _getwch_nolock.

Gets a character from the console without echo and without locking the thread.

Important

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

Syntax

int _getch_nolock( void );  
wint_t _getwch_nolock( void );

Return Value

Returns the character read. There is no error return.

Remarks

_getch_nolock and _getwch_nolock are identical to _getch and_getchw except that they not protected from interference by other threads. They might be faster because they do not incur the overhead of locking out other threads. Use these functions only in thread-safe contexts such as single-threaded applications or where the calling scope already handles thread isolation.

Generic-Text Routine Mappings

Tchar.h routine	_UNICODE and _MBCS not defined	_MBCS defined	_UNICODE defined
`_gettch_nolock`	`_getch_nolock`	`_getch_nolock`	`_getwch_nolock`

Requirements

Routine	Required header
`_getch_nolock`	<conio.h>
`_getwch_nolock`	<conio.h> or <wchar.h>

For more compatibility information, see Compatibility.

Example

// crt_getch_nolock.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_nolock();  
      ch = toupper( ch );  
   } while( ch != 'Y' );  
  
   _putch_nolock( ch );  
   _putch_nolock( '\r' );    // Carriage return  
   _putch_nolock( '\n' );    // Line feed  
}

  
abcdeyType 'Y' when finished typing keys: Y

NET Framework Equivalent

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