HidP_GetCaps routine

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

Syntax


NTSTATUS __stdcall HidP_GetCaps(
  _In_   PHIDP_PREPARSED_DATA PreparsedData,
  _Out_  PHIDP_CAPS Capabilities
);

Parameters

PreparsedData [in]

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

Capabilities [out]

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 codeDescription
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

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidpi.h (include Hidpi.h)

Library

Hidparse.lib

IRQL

PASSIVE_LEVEL

See also

_HIDP_PREPARSED_DATA
HidD_GetPreparsedData
HIDP_CAPS
IOCTL_HID_GET_COLLECTION_DESCRIPTOR
IOCTL_HID_GET_COLLECTION_INFORMATION

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft