HidD_GetNumInputBuffers function

Description

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.

Parameters

HidDeviceObject [in]

Specifies an open handle to a top-level collection.

NumberBuffers [out]

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

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.

See also

HidD_SetNumInputBuffers

IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS

IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS