Funzione PeekConsoleInput

Articolo
10/23/2023

Legge i dati dal buffer di input della console specificato senza rimuoverli dal buffer.

Sintassi

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

Parametri

hConsoleInput [in]
Handle per il buffer di input della console. L'handle deve avere il diritto di accesso GENERIC_READ . Per altre informazioni, vedere Sicurezza dei buffer della console e diritti di accesso.

lpBuffer [out]
Puntatore a una matrice di strutture INPUT_RECORD che riceve i dati del buffer di input.

nLength [in]
Dimensioni della matrice a cui punta il parametro lpBuffer , negli elementi della matrice.

lpNumberOfEventsRead [out]
Puntatore a una variabile che riceve il numero di record di input letti.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Osservazioni:

Se il numero di record richiesti supera il numero di record disponibili nel buffer, il numero disponibile viene letto. Se non sono disponibili dati, la funzione restituisce immediatamente.

Questa funzione usa i caratteri Unicode o i caratteri a 8 bit dalla tabella codici corrente della console. Inizialmente il valore predefinito della tabella codici della console è la tabella codici OEM del sistema. Per modificare la tabella codici della console usare le funzioni SetConsoleCP o SetConsoleOutputCP. I consumer legacy possono anche usare i comandichcp o mode con cp select= ma non è consigliabile per il nuovo sviluppo.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Intestazione	ConsoleApi.h (tramite WinCon.h, con Windows.h)
Libreria	Kernel32.lib
DLL	Kernel32.dll
Nomi Unicode e ANSI	PeekConsoleInputW (Unicode) e PeekConsoleInputA (ANSI)