PeekConsoleInput
The PeekConsoleInput
function reads data from the specified console input buffer without removing it
from the buffer.
BOOL PeekConsoleInput(
|
HANDLE hConsoleInput, |
// handle to a
console input buffer |
|
PINPUT_RECORD lpBuffer, |
// pointer to the
buffer for peek data |
|
DWORD nLength, |
// number of
records to read |
|
LPDWORD lpNumberOfEventsRead |
// pointer to
number of records read |
|
); |
|
Parameters
hConsoleInput
Identifies
the input buffer. The handle must have GENERIC_READ access.
lpBuffer
Points to an INPUT_RECORD buffer that receives the
input buffer data.
nLength
Specifies the
size, in records, of the buffer pointed to by the lpBuffer parameter.
lpNumberOfEventsRead
Points to a
32-bit 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: This function uses either Unicode
characters or 8-bit characters from the console's current codepage. The
console's codepage defaults initially to the system's OEM codepage. To change
the console's codepage, use the SetConsoleCP or SetConsoleOutputCP
functions, or use the chcp or mode con cp select= commands.
See Also