HidD_GetPreparsedData routine

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

Syntax


BOOLEAN __stdcall HidD_GetPreparsedData(
  _In_  HANDLE               HidDeviceObject,
  _Out_ PHIDP_PREPARSED_DATA *PreparsedData
);

Parameters

HidDeviceObject [in]

Specifies an open handle to a top-level collection.

PreparsedData [out]

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.

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

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

DLL

Hid.dll

See also

_HIDP_PREPARSED_DATA
HidD_FreePreparsedData
IOCTL_HID_GET_COLLECTION_DESCRIPTOR

 

 

Send comments about this topic to Microsoft

Show: