HidD_FlushQueue routine

The HidD_FlushQueue routine deletes all pending input reports in a top-level collection's input queue.

Syntax


BOOLEAN __stdcall HidD_FlushQueue(
  _In_ HANDLE HidDeviceObject
);

Parameters

HidDeviceObject [in]

Specifies an open handle to the top-level collection whose input queue is flushed.

Return value

HidD_FlushQueue returns TRUE if it successfully flushes the queue. Otherwise, it returns FALSE.

Remarks

Only user-mode applications can call HidD_FlushQueue. Kernel-mode drivers can use an IOCTL_HID_FLUSH_QUEUE request.

For more information, see HID Collections.

Requirements

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

DLL

Hid.dll

See also

IOCTL_HID_FLUSH_QUEUE

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft