HidP_MaxUsageListLength routine

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 __stdcall HidP_MaxUsageListLength(
  _In_  HIDP_REPORT_TYPE     ReportType,
  _In_  USAGE                UsagePage,
  _In_  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

ReportType [in]

Specifies a HIDP_REPORT_TYPE enumerator value that indicates the report type.

UsagePage [in]

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

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

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_GetButtons
HidP_GetUsages

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft