HidP_GetSpecificValueCaps routine

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

Syntax


NTSTATUS __stdcall HidP_GetSpecificValueCaps(
  _In_    HIDP_REPORT_TYPE     ReportType,
  _In_    USAGE                UsagePage,
  _In_    USHORT               LinkCollection,
  _In_    USAGE                Usage,
  _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.

UsagePage [in]

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

LinkCollection [in]

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

Usage [in]

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

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 buffer provided at ValueCaps. On output, this parameter is set to the number of elements that routine actually returns.

PreparsedData [in]

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

Return value

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

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidpi.h (include Hidpi.h)

Library

Hidparse.lib

IRQL

PASSIVE_LEVEL

See also

_HIDP_PREPARSED_DATA
HIDP_CAPS
HidP_GetCaps
HidP_GetValueCaps
HIDP_VALUE_CAPS

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft