HidP_GetCollectionDescription (Compact 2013)
3/26/2014
This function adds a linked list of collection descriptors to the DeviceDescription parameter block. It also adds the corresponding report-identifier information that is described by the specified report descriptor.
Syntax
NTSTATUS HidP_GetCollectionDescription(
PHIDP_REPORT_DESCRIPTOR ReportDesc,
ULONG DescLength,
POOL_TYPE PoolType,
PHIDP_DEVICE_DESC DeviceDescription
);
Parameters
- ReportDesc
[in] Raw report descriptor.
- DescLength
[in] Report descriptor length.
- PoolType
[in] Ignored, set to zero.
- DeviceDescription
[out] Device description block that the above lists will fill in.
Return Value
The following table shows the possible return values.
Value |
Description |
|---|---|
STATUS_SUCCESS |
No errors occurred when parsing the report descriptor and allocating the memory blocks necessary to describe the device. |
STATUS_NO_DATA_DETECTED |
No top-level collections existed in the report descriptor. |
STATUS_COULD_NOT_INTERPRET |
Report descriptor error detected. For more information on the parsing error, see the error code in the Dbg member of the device description block. |
STATUS_BUFFER_TOO_SMALL |
While parsing an item, the function reached the end of the report descriptor when it expected more data to exist. |
STATUS_INSUFFICIENT_RESOURCES |
Memory allocation failed. |
STATUS_ILLEGAL_INSTRUCTION |
An item existed in the report descriptor that the parser does not recognize. |
HIDP_STATUS_INVALID_REPORT_TYPE |
Report identifier of zero existed in the descriptor. |
Requirements
Header |
hidpddi.h |
Library |
Hidparse_lib.lib |