Edit

HidD_FlushQueue function (hidsdi.h)

  • Article

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

Syntax

BOOLEAN HidD_FlushQueue(
  [in] HANDLE HidDeviceObject
);

Parameters

[in] HidDeviceObject

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. Use GetLastError to get extended error information.

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

Requirement Value
Minimum supported client Available in Windows 2000 and later versions of Windows.
Target Platform Universal
Header hidsdi.h (include Hidsdi.h)
Library Hid.lib
DLL Hid.dll

See also

IOCTL_HID_FLUSH_QUEUE