HidP_GetSpecificValueCaps
This function returns a value capability array that describes all HID control values that meet specified selection criteria.
NTSTATUS HidP_GetSpecificValueCaps(
HIDP_REPORT_TYPE ReportType,
USAGE UsagePage,
USHORT LinkCollection,
USAGE Usage,
PHIDP_VALUE_CAPS ValueCaps,
PULONG ValueCapsLength,
PHIDP_PREPARSED_DATA PreparsedData
);
Parameters
- ReportType
[in] HIDP_REPORT_TYPE enumerator value that identifies the report type. - UsagePage
[in] Usage page as search criteria. If UsagePage is nonzero, this function only returns values that specify this usage page. - LinkCollection
[in] Link collection as search criteria. If LinkCollection is nonzero, this function only returns values that are part of this link collection. - Usage
[in] HID usage as search criteria. If Usage is nonzero, this function only returns values that specify this usage. - ValueCaps
[out] Pointer to a caller-allocated buffer for the function to return a value capability array for the specified report type. - ValueCapsLength
[in, out] On input, length in array elements of the buffer provided at ValueCaps. On output, the number of elements the function returns. - 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 required size of the ValueCaps buffer is specified by the NumberXXXValueCaps members of a top-level collection's HIDP_CAPS structure.
When calling HidP_GetSpecificValueCaps, specifying zero for UsagePage, Usage, and LinkCollection is equivalent to calling HidP_GetValueCaps.
Requirements
OS Versions: Windows CE .NET 4.2 and later.
Header: Hidpi.h.
Link Library: Hidparse_lib.lib.
See Also
HID Drivers | HIDP_CAPS | HidP_GetCaps | HidP_GetValueCaps | HIDP_REPORT_TYPE | HIDP_VALUE_CAPS
Last updated on Tuesday, May 18, 2004
© 1992-2003 Microsoft Corporation. All rights reserved.