HidD_GetNumInputBuffers function

The HidD_GetNumInputBuffers routine returns the current size, in number of reports, of the ring buffer that the HID class driver uses to queue input reports from a specified top-level collection.

Syntax

BOOLEAN HidD_GetNumInputBuffers(
  HANDLE HidDeviceObject,
  PULONG NumberBuffers
);

Parameters

HidDeviceObject

Specifies an open handle to a top-level collection.

NumberBuffers

Pointer to a caller-allocated variable that the routine uses to return the maximum number of input reports the ring buffer can hold.

Return Value

HidD_GetNumInputBuffers returns TRUE if it succeeds; otherwise, it returns FALSE.

Remarks

Only user-mode applications can call HidD_GetNumInputBuffers. Kernel-mode drivers can use the IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS request.

For more information, see HID Collections.

Requirements

   
Windows version 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

HidD_SetNumInputBuffers

IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS

IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS