Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 3.18 KB

nf-hidsdi-hidd_setnuminputbuffers.md

File metadata and controls

80 lines (58 loc) · 3.18 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:hidsdi.HidD_SetNumInputBuffers
HidD_SetNumInputBuffers function (hidsdi.h)
The HidD_SetNumInputBuffers routine sets the maximum number of input reports that the HID class driver ring buffer can hold for a specified top-level collection.
hid\hidd_setnuminputbuffers.htm
hid
06/19/2019
HidD_SetNumInputBuffers function
HidD_SetNumInputBuffers, HidD_SetNumInputBuffers routine [Human Input Devices], hid.hidd_setnuminputbuffers, hidfunc_d091d988-7b9d-44ef-ae48-e00af69c12f5.xml, hidsdi/HidD_SetNumInputBuffers
hidsdi.h
Hidsdi.h
Universal
Available in Windows 2000 and later versions of Windows.
Hid.lib
Hid.dll
Windows
HidD_SetNumInputBuffers
hidsdi/HidD_SetNumInputBuffers
APIRef
kbSyntax
DllExport
Hid.dll
HidD_SetNumInputBuffers

HidD_SetNumInputBuffers function

-description

The HidD_SetNumInputBuffers routine sets the maximum number of input reports that the HID class driver ring buffer can hold for a specified top-level collection.

-parameters

-param HidDeviceObject [in]

Specifies an open handle to a top-level collection.

-param NumberBuffers [in]

Specifies the maximum number of buffers that the HID class driver should maintain for the input reports generated by the HidDeviceObject collection.

-returns

HidD_SetNumInputBuffers returns TRUE if it succeeds; otherwise, it returns FALSE. Use GetLastError to get extended error information.

-remarks

Only user-mode applications can call HidD_SetNumInputBuffers. Kernel-mode drivers must use an IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS request.

If HidD_SetNumInputBuffers returns FALSE, and the Microsoft Win32 GetLastError function indicates that an invalid parameter was supplied, the value of NumberBuffers is invalid. The HID class driver requires a minimum of two input buffers. On Windows 2000, the maximum number of input buffers that the HID class driver supports is 200, and on Windows XP and later, the maximum number of input buffers that the HID class driver supports is 512. The default number of input buffers is 32.

For more information, see HID Collections.

-see-also

HidD_GetNumInputBuffers

IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS