HidD_GetPreparsedData function (hidsdi.h)

The HidD_GetPreparsedData routine returns a top-level collection's preparsed data.

Syntax

BOOLEAN HidD_GetPreparsedData(
  [in]  HANDLE               HidDeviceObject,
  [out] PHIDP_PREPARSED_DATA *PreparsedData
);

Parameters

[in] HidDeviceObject

Specifies an open handle to a top-level collection.

[out] PreparsedData

Pointer to the address of a routine-allocated buffer that contains a collection's preparsed data in a _HIDP_PREPARSED_DATA structure.

Return value

HidD_GetPreparsedData returns TRUE if it succeeds; otherwise, it returns FALSE. Use GetLastError to get extended error information.

Remarks

Only user-mode applications can call HidD_GetPreparsedData. Kernel-mode drivers can use an IOCTL_HID_GET_COLLECTION_DESCRIPTOR request.

When an application no longer requires the preparsed data, it should call HidD_FreePreparsedData to free the preparsed data buffer.

For more information, see HID Collections.

Requirements

See also

HidD_FreePreparsedData

IOCTL_HID_GET_COLLECTION_DESCRIPTOR

_HIDP_PREPARSED_DATA