HidP_GetValueCaps routine

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 __stdcall HidP_GetValueCaps(
  _In_    HIDP_REPORT_TYPE     ReportType,
  _Out_   PHIDP_VALUE_CAPS     ValueCaps,
  _Inout_ PUSHORT              ValueCapsLength,
  _In_    PHIDP_PREPARSED_DATA PreparsedData
);

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 codeDescription
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

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidpi.h (include Hidpi.h)

Library

Hidparse.lib

IRQL

<= DISPATCH_LEVEL

See also

_HIDP_PREPARSED_DATA
HIDP_CAPS
HidP_GetCaps
HidP_GetButtonCaps
HIDP_VALUE_CAPS

 

 

Send comments about this topic to Microsoft

Show: