Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Definitions that are common to clients of the HID class driver.
For more information, see:
hidclass.h contains the following programming interfaces:
IOCTLs
IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS The IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS request obtains the size of the input report queue for a top-level collection. |
IOCTL_GET_PHYSICAL_DESCRIPTOR The IOCTL_GET_PHYSICAL_DESCRIPTOR request obtains the physical descriptor of a top-level collection. For a minidriver, this descriptor is the descriptor of the HIDClass device. |
IOCTL_HID_DEVICERESET_NOTIFICATION The IOCTL_HID_DEVICERESET_NOTIFICATION request is sent by the HID client driver to HID class driver to wait for a device-initiated reset event. |
IOCTL_HID_DISABLE_SECURE_READ The IOCTL_HID_DISABLE_SECURE_READ request cancels an IOCTL_HID_ENABLE_SECURE_READ request for a HID collection. |
IOCTL_HID_ENABLE_SECURE_READ The IOCTL_HID_ENABLE_SECURE_READ request enables a secure read for open files of a HID collection. |
IOCTL_HID_ENABLE_WAKE_ON_SX The IOCTL_HID_ENABLE_WAKE_ON_SX request is used to indicate the requirement for a device to be able to wake from system sleep. |
IOCTL_HID_FLUSH_QUEUE The IOCTL_HID_FLUSH_QUEUE request dequeues all of the unparsed input reports from a top-level collection's input report queue. |
IOCTL_HID_GET_COLLECTION_DESCRIPTOR The IOCTL_HID_GET_COLLECTION_DESCRIPTOR request obtains a top-level collection's preparsed data, which the HID class driver extracted from the physical device's report descriptor during device initialization. |
IOCTL_HID_GET_COLLECTION_INFORMATION The IOCTL_HID_GET_COLLECTION_INFORMATION request obtains a top-level collection's HID_COLLECTION_INFORMATION structure. |
IOCTL_HID_GET_DRIVER_CONFIG The IOCTL_HID_GET_DRIVER_CONFIG request retrieves the driver configuration. |
IOCTL_HID_GET_FEATURE The IOCTL_HID_GET_FEATURE request returns a feature report associated with a top-level collection. |
IOCTL_HID_GET_HARDWARE_ID The IOCTL_HID_GET_HARDWARE_ID request obtains the Plug and Play hardware ID of a top-level collection. |
IOCTL_HID_GET_INDEXED_STRING The IOCTL_HID_GET_INDEXED_STRING request obtains a specified embedded string from a top-level collection. |
IOCTL_HID_GET_INPUT_REPORT The IOCTL_HID_GET_INPUT_REPORT request obtains an input report from a top-level collection. |
IOCTL_HID_GET_MANUFACTURER_STRING The IOCTL_HID_GET_MANUFACTURER_STRING request obtains a top-level collection's embedded string that identifies the manufacturer of the device. |
IOCTL_HID_GET_MS_GENRE_DESCRIPTOR The IOCTL_HID_GET_MS_GENRE_DESCRIPTOR request is used for retrieving the genre descriptor for the device. |
IOCTL_HID_GET_POLL_FREQUENCY_MSEC The IOCTL_HID_GET_POLL_FREQUENCY_MSEC request obtains the current polling frequency, in milliseconds, of a top-level collection. |
IOCTL_HID_GET_PRODUCT_STRING The IOCTL_HID_GET_PRODUCT_STRING request obtains a top-level collection's embedded string that identifies the manufacturer's product. The retrieved string is a NULL-terminated wide character string in a human-readable format. |
IOCTL_HID_GET_SERIALNUMBER_STRING The IOCTL_HID_GET_SERIALNUMBER_STRING request obtains a top-level collection's embedded string that identifies the device's serial number. |
IOCTL_HID_SET_DRIVER_CONFIG The IOCTL_HID_SET_DRIVER_CONFIG request sets the driver configuration. |
IOCTL_HID_SET_FEATURE The IOCTL_HID_SET_FEATURE request sends a feature report to a top-level collection. |
IOCTL_HID_SET_OUTPUT_REPORT The IOCTL_HID_SET_OUTPUT_REPORT request sends an output report to a top-level collection. |
IOCTL_HID_SET_POLL_FREQUENCY_MSEC The IOCTL_HID_SET_POLL_FREQUENCY_MSEC request sets the polling frequency, in milliseconds, for a top-level collection. |
IOCTL_HID_SET_S0_IDLE_TIMEOUT The IOCTL_HID_SET_S0_IDLE_TIMEOUT request is used by a client to inform the HID class driver about the client's preferred idle timeout value. |
IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS The IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS request sets the number of buffers for the input report queue of a top-level collection. |
Callback functions
PHIDP_GETCAPS The HidP_GetCaps routine returns a top-level collection's HIDP_CAPS structure. This routine is in hidclass.h. |
Structures
HID_COLLECTION_INFORMATION The HID_COLLECTION_INFORMATION structure contains general information about a top-level collection. |
HID_XFER_PACKET The HID_XFER_PACKET structure in hidclass.he contains information about a HID report that the HID class driver uses with I/O requests to get or set a report. |