HidP_MaxDataListLength function (hidpi.h)

Article
02/22/2024

The HidP_MaxDataListLength routine 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(
  [in] HIDP_REPORT_TYPE     ReportType,
  [in] PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

[in] ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that indicates the report type.

[in] PreparsedData

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 routine returns zero, which indicates that either the report type or the preparsed data is not valid.

Remarks

User-mode applications or kernel-mode drivers call HidP_MaxDataListLength to determine the maximum number of HIDP_DATA structures that HidP_GetData can return.

For more information, see HID Collections.

Requirements

Requirement	Value
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	<= DISPATCH_LEVEL