PeekConsoleInput

The PeekConsoleInput function reads data from the specified console input buffer without removing it from the buffer.

BOOL PeekConsoleInput(
  HANDLE hConsoleInput,         // handle to console input buffer
  PINPUT_RECORD lpBuffer,       // peek data
  DWORD nLength,                // number of records to read
  LPDWORD lpNumberOfEventsRead  // number of records read
);

Parameters

hConsoleInput

[in] Handle to the input buffer. The handle must have GENERIC_READ access.

lpBuffer

[out] Pointer to an INPUT_RECORD buffer that receives the input buffer data.

nLength

[in] Specifies the size, in records, of the buffer pointed to by the lpBuffer parameter.

lpNumberOfEventsRead

[out] Pointer to a variable that receives the number of input records read.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the number of records requested exceeds the number of records available in the buffer, the number available is read. If no data is available, the function returns immediately.

Windows NT/2000: This function uses either Unicode characters or 8-bit characters from the console's current code page. The console's code page defaults initially to the system's OEM code page. To change the console's code page, use the SetConsoleCP or SetConsoleOutputCP functions, or use the chcp or mode con cp select= commands.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Wincon.h; include Windows.h.
  Library: Use Kernel32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Consoles and Character-Mode Support Overview, Console Functions, INPUT_RECORD, ReadConsoleInput, SetConsoleCP, SetConsoleOutputCP, WriteConsoleInput