HidP_MaxDataListLength routine

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

Parameters

ReportType [in]

Specifies a 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 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

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidpi.h (include Hidpi.h)

Library

Hidparse.lib

IRQL

<= DISPATCH_LEVEL

See also

_HIDP_PREPARSED_DATA
HIDP_DATA
HidP_GetData
HidP_SetData

 

 

Send comments about this topic to Microsoft

Show: