HidP_MaxDataListLength function (hidpi.h)

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

See also

HIDP_DATA

HidP_GetData

HidP_SetData

_HIDP_PREPARSED_DATA