HidP_GetValueCaps - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers 
// hidpi.h

NTSTATUS HidP_GetValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Edit description on GitHub

Windows Driver Kit DDI reference (nf-hidpi-hidp_getvaluecaps)

HidP_GetValueCaps function

Description

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.

Parameters

ReportType [in]

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the report type.

ValueCaps [out]

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

ValueCapsLength [in, out]

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 [in]

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.

See also

HIDP_CAPS

HIDP_VALUE_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA

View the official Windows Driver Kit DDI reference

Edit description on GitHub