HidP_GetCaps function (hidpi.h)

The HidP_GetCaps routine returns a top-level collection's HIDP_CAPS structure.

Syntax

NTSTATUS HidP_GetCaps(
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PHIDP_CAPS           Capabilities
);

Parameters

[in] PreparsedData

Pointer to a top-level collection's preparsed data.

[out] Capabilities

Pointer to a caller-allocated buffer that the routine uses to return a collection's HIDP_CAPS structure.

Return value

HidP_GetCaps returns one of the following status values:

Return code	Description
HIDP_STATUS_SUCCESS	The routine successfully returned the collection capability information.
HIDP_STATUS_INVALID_PREPARSED_DATA	The specified preparsed data is invalid.

Remarks

For more information about a collection's capability, see Obtaining Collection Information.

See also HID Collections.

Requirements

Minimum supported client	Available in Windows 2000 and later versions of Windows.
Target Platform	Universal
Header	hidpi.h (include Hidclass.h)
IRQL	PASSIVE_LEVEL

See also

HIDP_CAPS

HidD_GetPreparsedData

IOCTL_HID_GET_COLLECTION_DESCRIPTOR

IOCTL_HID_GET_COLLECTION_INFORMATION

_HIDP_PREPARSED_DATA