HidP_GetSpecificValueCaps function (hidpi.h)

The HidP_GetSpecificValueCaps routine returns a value capability array that describes all HID control values that meet a specified selection criteria.

Syntax

NTSTATUS HidP_GetSpecificValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

[in] ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the report type.

[in] UsagePage

Specifies a usage page as a search criteria. If UsagePage is nonzero, only values that specify this usage page are returned.

[in] LinkCollection

Specifies a link collection as a search criteria. If LinkCollection is nonzero, only values that are part of this link collection are returned.

[in] Usage

Specifies a HID usage as a search criteria. If Usage is nonzero, only values that specify this usage will be returned.

[out] ValueCaps

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

[in, out] ValueCapsLength

Specifies the length on input, in array elements, of the buffer provided at ValueCaps. On output, this parameter is set to the number of elements that routine actually returns.

[in] PreparsedData

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

Return value

HidP_GetSpecificValueCaps returns one of the following status values:

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.

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

See also HID Collections.

Requirements

See also

HIDP_CAPS

HIDP_VALUE_CAPS

HidP_GetCaps

HidP_GetValueCaps

_HIDP_PREPARSED_DATA