HidP_GetValueCaps function

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.

Syntax

NTSTATUS HidP_GetValueCaps(
  HIDP_REPORT_TYPE     ReportType,
  PHIDP_VALUE_CAPS     ValueCaps,
  PUSHORT              ValueCapsLength,
  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the report type.

ValueCaps

Pointer to a caller-allocated buffer in which the routine returns a value capability array for the specified report type.

ValueCapsLength

Specifies the length, on input, in array elements, of the ValueCaps buffer. On output, the routine sets ValueCapsLength to the number of elements that the it actually returns.

PreparsedData

Pointer to a top-level collection's preparsed data.

Return Value

HidP_GetValueCaps returns one of the following status values:

Return code Description
HIDP_STATUS_SUCCESS
The routine successfully returned the capability data.
HIDP_STATUS_INVALID_PREPARSED_DATA
The preparsed data is not valid.

Remarks

The correct length for ValueCapsLength is specified by the NumberXxxValueCaps members of a top-level collection's HIDP_CAPS structure.

For more information about a collection's capability, see Obtaining Collection Information.

See also HID Collections.

Requirements

   
Windows version Available in Windows 2000 and later versions of Windows.
Target Platform Universal
Header hidpi.h (include Hidpi.h)
Library Hidparse.lib
IRQL "<= DISPATCH_LEVEL"

See Also

HIDP_CAPS

HIDP_VALUE_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA