HidD_GetNumInputBuffers routine

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 __stdcall HidD_GetNumInputBuffers(
  _In_  HANDLE HidDeviceObject,
  _Out_ PULONG NumberBuffers
);

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.

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

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

HidD_SetNumInputBuffers
IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS
IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS

 

 

Send comments about this topic to Microsoft

Show: