HidP_MaxUsageListLength (Windows CE 5.0)

Send Feedback

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

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

Parameters

• ReportType
  [in] HIDP_REPORT_TYPE enumerator value that indicates the report type.
• UsagePage
  [in] Optional. Usage page as search criteria. If UsagePage is zero, the function returns the number of the buttons in the collection.
• PreparsedData
  [in] Pointer to a top-level collection's preparsed data.

Return Values

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 function returns zero.

Remarks

The terms button and usage are used synonymously.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Hidpi.h.
Link Library: Hidparse_lib.lib.

See Also

HidP_GetButtons | HidP_GetUsages | HIDP_REPORT_TYPE

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.