HidD_GetNumInputBuffers function (hidsdi.h)

Article
02/22/2024

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(
  [in]  HANDLE HidDeviceObject,
  [out] PULONG NumberBuffers
);

Parameters

[in] HidDeviceObject

Specifies an open handle to a top-level collection.

[out] 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. 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.

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