HidP_GetSpecificButtonCaps (Windows CE 5.0)
This function returns a button capability array that describes all HID control buttons in a top-level collection that meet a specified selection criteria.
NTSTATUS HidP_GetSpecificButtonCaps( HIDP_REPORT_TYPE ReportType, USAGE UsagePage, USHORT LinkCollection, USAGE Usage, PULONG ButtonCapsLength, PHIDP_PREPARSED_DATA PreparsedData);
Parameters
- ReportType
[in] HIDP_REPORT_TYPE enumerator value that identifies the report type. - UsagePage
[in] Usage page as a search criteria. If UsagePage is nonzero, this function only returns buttons that specify this usage page. - LinkCollection
[in] Link collection as search criteria. If LinkCollection is nonzero, this function only returns buttons that are part of this link collection. - Usage
[in] HID usage as search criteria. If Usage is nonzero, this function only returns buttons that specify this usage. - ButtonCaps
[out] Pointer to a caller-allocated buffer in which the function returns a button capability array for the specified report type. - ButtonCapsLength
[in, out] On input, length in array elements of the buffer provided at ButtonCaps. On output, number of elements that the function returned. - PreparsedData
[in] Pointer to a top-level collection's preparsed data.
Return Values
Returns HIDP_STATUS_SUCCESS if the function successfully returned the capability data. Returns HIDP_STATUS_INVALID_PREPARSED_DATA if the preparsed data is not valid.
Remarks
The terms button and usage are used synonymously.
The NumberXXXButtonCaps members of a top-level collection's HIDP_CAPS structure specify the required size of the ButtonCaps array.
Calling HidP_GetSpecificButtonCaps, and specifying zero for UsagePage, Usage, and LinkCollection is equivalent to calling HidP_GetButtonCaps.
Requirements
OS Versions: Windows CE .NET 4.2 and later.
Header: Hidpi.h.
Link Library: Hidparse_lib.lib.
See Also
HidP_GetButtonCaps | HidP_GetCaps | HIDP_BUTTON_CAPS | HIDP_REPORT_TYPE
Send Feedback on this topic to the authors