hidpi.h header
Public Interface to the HID parsing library.
For more information, see:
hidpi.h contains the following programming interfaces:
Functions
| HidP_GetButtonArray HidP_GetButtonArray returns an array of HIDP_BUTTON_ARRAY_DATA structures for the specified report. |
| HidP_GetButtonCaps The HidP_GetButtonCaps routine returns a button capability array that describes all the HID control buttons in a top-level collection for a specified type of HID report. |
| HidP_GetButtons The HidP_GetButtons macro is a mnemonic alias for the HHidP_GetUsages function. |
| HidP_GetButtonsEx The HidP_GetButtonsEx macro is an mnemonic alias for the HidP_GetUsagesEx function. |
| HidP_GetCaps The HidP_GetCaps routine returns a top-level collection's HIDP_CAPS structure. This routine is in hidpi.h. |
| HidP_GetData The HidP_GetData routine returns, for a specified report, an array of HIDP_DATA structures that identify the data indices of all HID control buttons that are currently set to ON (1), and the data indices and data associated with all HID control values. |
| HidP_GetExtendedAttributes The HidP_GetExtendedAttributes routine returns the extended attributes of a HID control. |
| HidP_GetLinkCollectionNodes The HidP_GetLinkCollectionNodes routine returns a top-level collection's link collection array. |
| HidP_GetScaledUsageValue The HidP_GetScaledUsageValue routine returns the signed and scaled result of a HID control value extracted from a HID report. |
| HidP_GetSpecificButtonCaps The HidP_GetSpecificButtonCaps routine returns a button capability array that describes all HID control buttons in a top-level collection that meet a specified selection criteria. |
| HidP_GetSpecificValueCaps The HidP_GetSpecificValueCaps routine returns a value capability array that describes all HID control values that meet a specified selection criteria. |
| HidP_GetUsages The HidP_GetUsages routine returns a list of all the HID control button usages that are on a specified usage page and are set to ON in a HID report. |
| HidP_GetUsagesEx The HidP_GetUsagesEx routine returns a list of the all the HID control button usages that are set to ON in a HID report. |
| HidP_GetUsageValue The HidP_GetUsageValue routine extracts the data associated with a HID control value that matches the selection criteria in a HID report. |
| HidP_GetUsageValueArray The HidP_GetUsageValueArray routine extracts the data associated with a HID control usage value array from a HID report. |
| HidP_GetValueCaps The HidP_GetValueCaps routine returns a value capability array that describes all the HID control values in a top-level collection for a specified type of HID report. |
| HidP_GetVersion The HidP_GetVersion function is a header-only implementation that returns the HID API version. |
| HidP_InitializeReportForID The HidP_InitializeReportForID routine initializes a HID report. |
| HidP_MaxDataListLength The HidP_MaxDataListLength routine returns the maximum number of HIDP_DATA structures that HidP_GetData can return for a specified type of HID report and a specified top-level collection. |
| HidP_MaxUsageListLength The HidP_MaxUsageListLength routine returns the maximum number of HID usages that HidP_GetUsages can return for a specified type of HID report and a specified top-level collection. |
| HidP_SetButtonArray The HidP_SetButtonArray function sets the state of buttons via an array of HIDP_BUTTON_ARRAY_DATA structures. |
| HidP_SetButtons The HidP_SetButtons macro is a mnemonic alias for the HidP_SetUsages function. |
| HidP_SetData The HidP_SetData routine sets a specified set of HID control button and value usages in a HID report. |
| HidP_SetScaledUsageValue The HidP_SetScaledUsageValue routine 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_SetUsages The HidP_SetUsages routine sets specified HID control buttons ON (1) in a HID report. |
| HidP_SetUsageValue The HidP_SetUsageValue routine sets a HID control value in a specified HID report. |
| HidP_SetUsageValueArray The HidP_SetUsageValueArray routine sets a HID control usage value array in a specified HID report. |
| HidP_TranslateUsagesToI8042ScanCodes The HidP_TranslateUsagesToI8042ScanCodes routine maps a list of HID usages on the HID_USAGE_PAGE_KEYBOARD usage page to their respective PS/2 scan codes (Scan Code Set 1). |
| HidP_UnsetButtons The HidP_UnsetButtons macro is a mnemonic alias for the HidP_UnsetUsages function. |
| HidP_UnsetUsages The HidP_UnsetUsages routine sets specified HID control button usages OFF (zero) in a HID report. |
| HidP_UsageAndPageListDifference The HidP_UsageAndPageListDifference function returns the difference between two lists of usages. |
| HidP_UsageListDifference The HidP_UsageListDifference routine returns the differences between two arrays of HID usages. |
Structures
| HIDP_BUTTON_ARRAY_DATA The HIDP_BUTTON_ARRAY_DATA structure is used to get or set data for single button in a button array. |
| HIDP_BUTTON_CAPS The HIDP_BUTTON_CAPS structure contains information about the capability of a HID control button usage (or a set of buttons associated with a usage range). |
| HIDP_CAPS The HIDP_CAPS structure contains information about a top-level collection's capability. |
| HIDP_DATA The HIDP_DATA structure contains information about a HID control's data index and value in a HID report. |
| HIDP_EXTENDED_ATTRIBUTES The HIDP_EXTENDED_ATTRIBUTES structure contains information about the global items specified for a HID control that the HID parser did not recognize. |
| HIDP_LINK_COLLECTION_NODE The HIDP_LINK_COLLECTION_NODE structure contains information about a link collection in a top-level collection's link collection array. |
| HIDP_UNKNOWN_TOKEN The HIDP_UNKNOWN_TOKEN structure contains information about a global item that the HID parser did not recognize. |
| HIDP_VALUE_CAPS The HIDP_VALUE_CAPS structure contains information that describes the capability of a set of HID control values (either a single usage or a usage range). |
| USAGE_AND_PAGE The USAGE_AND_PAGE structure specifies the usage page and usage ID of a HID control. |
Enumerations
| HIDP_REPORT_TYPE The HIDP_REPORT_TYPE enumeration type is used to specify a HID report type. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for