FlushConsoleInputBuffer function

Flushes the console input buffer. All input records currently in the input buffer are discarded.

Syntax


BOOL WINAPI FlushConsoleInputBuffer(
  _In_  HANDLE hConsoleInput
);

Parameters

hConsoleInput [in]

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

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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wincon.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions
Low-Level Console Input Functions
GetNumberOfConsoleInputEvents
PeekConsoleInput
ReadConsoleInput
WriteConsoleInput

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.