Share via

HidP_MaxDataListLength (Compact 2013)

  • Article

3/26/2014

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

Syntax

ULONG HidP_MaxDataListLength(
  HIDP_REPORT_TYPE ReportType,
  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

  • ReportType
    [in] HIDP_REPORT_TYPE enumerator value that indicates the report type.
  • PreparsedData
    [in] Pointer to a top-level collection's preparsed data.

Return Value

If successful, HidP_MaxDataListLength returns the maximum number of HIDP_DATA structures that HidP_GetData might return for a specified type of HID report and a specified top-level collection. Otherwise, the function returns zero, which indicates that either the report type or the preparsed data is not valid.

Remarks

HID client drivers call HidP_MaxDataListLength to determine the maximum number of HIDP_DATA structures that HidP_GetData can return.

Requirements

Header

hidpi.h

Library

Hidparse_lib.lib

See Also

Reference

HID Parser Functions
HIDP_DATA
HidP_GetData
HIDP_REPORT_TYPE
HidP_SetData