HidP_MaxUsageListLength function

The HidP_MaxUsageListLength routine returns the maximum number of HID usages that HidP_GetUsages can return for a specified type of HID report and a specified top-level collection.

Syntax

ULONG HidP_MaxUsageListLength(
  HIDP_REPORT_TYPE     ReportType,
  USAGE                UsagePage,
  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that indicates the report type.

UsagePage

Specifies a usage page as a search criteria. If UsagePage is zero, the routine returns the number of all the buttons in the collection.

PreparsedData

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

Return Value

If successful, HidP_MaxUsageListLength returns the maximum number of HID usages that HidP_GetUsages can return for a specified type of HID report and a specified top-level collection. If the specified preparsed data or report type is not valid, the routine returns zero.

Remarks

For more information, see HID Collections.

Requirements

   
Minimum supported client Available in Windows 2000 and later versions of Windows.
Target Platform Universal
Header hidpi.h (include Hidpi.h)
Library Hidparse.lib
IRQL PASSIVE_LEVEL

See Also

HidP_GetButtons

HidP_GetUsages

_HIDP_PREPARSED_DATA