HidP_MaxDataListLength
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
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 |
| Windows Embedded CE | Windows CE .NET 4.2 and later |