peekconsoleinput.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
PeekConsoleInput function	Reads data from the specified console input buffer without removing it from the buffer.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi/PeekConsoleInput wincon/PeekConsoleInput PeekConsoleInput consoleapi/PeekConsoleInputA wincon/PeekConsoleInputA PeekConsoleInputA consoleapi/PeekConsoleInputW wincon/PeekConsoleInputW PeekConsoleInputW	\_win32\_peekconsoleinput base.peekconsoleinput consoles.peekconsoleinput	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	9982dc20-43bd-4ee3-a68d-157c9134daca	apiref	PeekConsoleInput PeekConsoleInputA PeekConsoleInputW	Kernel32.dll API-MS-Win-Core-Console-l1-1-0.dll API-MS-Win-Core-Console-l1-2-0.dll KernelBase.dll API-MS-Win-Core-Console-l2-1-0.dll API-MS-Win-DownLevel-Kernel32-l1-1-0.dll MinKernelBase.dll	DllExport

PeekConsoleInput function

Reads data from the specified console input buffer without removing it from the buffer.

Syntax

BOOL WINAPI PeekConsoleInput(
  _In_  HANDLE        hConsoleInput,
  _Out_ PINPUT_RECORD lpBuffer,
  _In_  DWORD         nLength,
  _Out_ LPDWORD       lpNumberOfEventsRead
);

Parameters

hConsoleInput [in]
A handle to the console input buffer. The handle must have the GENERIC_READ access right. For more information, see Console Buffer Security and Access Rights.

lpBuffer [out]
A pointer to an array of INPUT_RECORD structures that receives the input buffer data.

nLength [in]
The size of the array pointed to by the lpBuffer parameter, in array elements.

lpNumberOfEventsRead [out]
A pointer to a variable that receives the number of input records read.

Return value

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.

[!INCLUDE setting-codepage-mode-remarks]

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	ConsoleApi.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll
Unicode and ANSI names	PeekConsoleInputW (Unicode) and PeekConsoleInputA (ANSI)

See also

Console Functions

ReadConsoleInput

SetConsoleCP

SetConsoleOutputCP

WriteConsoleInput

INPUT_RECORD