HID Preparsed Data

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

Preparsed data is report-descriptor data associated with a top-level HID collection. Parsed data is data from a HID device after the data has been operated on by the HID parser functions. HID client drivers can use preparsed data to extract information about specific HID controls without having to obtain and interpret the entire report descriptor for a device.

The following table shows the macros and functions that support extracting and setting button and value data.

Function Description

HidP_GetButtons

Returns a list of the HID control button usages that are on a specified usage page and are set to On in a HID report.

HidP_GetButtonsEx

Returns a list of the HID control button usages that are set toOn in a HID report.

HidP_GetScaledUsageValue

Returns the signed and scaled result of a HID control value extracted from a HID report.

HidP_GetUsageValue

Extracts the data associated with a HID control value that matches selection criteria in a HID report.

HidP_GetUsageValueArray

Extracts the data associated with a HID control usage value array from a HID report.

HidP_SetButtons

Sets the specified HID control buttons to On in a HID report.

HidP_SetScaledUsageValue

Converts a signed and scaled physical number to a HID usage's logical value, and sets the usage value in a specified HID report.

HidP_SetUsageValue

Sets a HID control usage value in a specified HID report.

HidP_SetUsageValueArray

Sets a HID control usage value array in a specified HID report.

HidP_UnsetButtons

Sets the specified HID control button usages to Off in a HID report.