Share via

HidP_GetValueCaps (Compact 2013)

  • Article

3/26/2014

This function returns a value capability array that describes 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,
  PULONG ValueCapsLength,
  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

  • ReportType
    [in] HIDP_REPORT_TYPE enumerator value that identifies the report type.
  • ValueCaps
    [out] Pointer to a caller-allocated buffer in which the function returns a value capability array for the specified report type.
  • ValueCapsLength
    [in, out] On input, the length in array elements of the ValueCaps buffer. On output, the number of elements that the ValueCaps buffer returns.
  • PreparsedData
    [in] Pointer to a top-level collection's preparsed data.

Return Value

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 NumberXXXValueCaps members of a top-level collection's HIDP_CAPS structure specify the correct length for ValueCapsLength.

Requirements

Header

hidpi.h

Library

Hidparse_lib.lib

See Also

Reference

HID Parser Functions
HIDP_CAPS
HidP_GetCaps
HIDP_VALUE_CAPS