HIDP_CAPS structure

The HIDP_CAPS structure contains information about a top-level collection's capability.

Syntax

typedef struct _HIDP_CAPS {
  USAGE  UsagePage;
  USAGE  Usage;
  USHORT InputReportByteLength;
  USHORT OutputReportByteLength;
  USHORT FeatureReportByteLength;
  USHORT Reserved[17];
  USHORT NumberLinkCollectionNodes;
  USHORT NumberInputButtonCaps;
  USHORT NumberInputValueCaps;
  USHORT NumberInputDataIndices;
  USHORT NumberOutputButtonCaps;
  USHORT NumberOutputValueCaps;
  USHORT NumberOutputDataIndices;
  USHORT NumberFeatureButtonCaps;
  USHORT NumberFeatureValueCaps;
  USHORT NumberFeatureDataIndices;
} HIDP_CAPS, *PHIDP_CAPS;

Members

UsagePage

Specifies the top-level collection's usage page.

Usage

Specifies a top-level collection's usage ID.

InputReportByteLength

Specifies the maximum size, in bytes, of all the input reports (including the report ID, if report IDs are used, which is prepended to the report data).

OutputReportByteLength

Specifies the maximum size, in bytes, of all the output reports (including the report ID, if report IDs are used, which is prepended to the report data).

FeatureReportByteLength

Specifies the maximum length, in bytes, of all the feature reports (including the report ID, if report IDs are used, which is prepended to the report data).

Reserved

Reserved for internal system use.

NumberLinkCollectionNodes

Specifies the number of HIDP_LINK_COLLECTION_NODE structures that are returned for this top-level collection by HidP_GetLinkCollectionNodes.

NumberInputButtonCaps

Specifies the number of input HIDP_BUTTON_CAPS structures that HidP_GetButtonCaps returns.

NumberInputValueCaps

Specifies the number of input HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

NumberInputDataIndices

Specifies the number of data indices assigned to buttons and values in all input reports.

NumberOutputButtonCaps

Specifies the number of output HIDP_BUTTON_CAPS structures that HidP_GetButtonCaps returns.

NumberOutputValueCaps

Specifies the number of output HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

NumberOutputDataIndices

Specifies the number of data indices assigned to buttons and values in all output reports.

NumberFeatureButtonCaps

Specifies the total number of feature HIDP_BUTTONS_CAPS structures that HidP_GetButtonCaps returns.

NumberFeatureValueCaps

Specifies the total number of feature HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

NumberFeatureDataIndices

Specifies the number of data indices assigned to buttons and values in all feature reports.

Remarks

Callers of the HIDClass support routines use the information provided in this structure when a called routine requires, as input, the size of a report type, the number of link collection nodes, the number of control capabilities, or the number of data indices.

Requirements

   
Header hidpi.h (include Hidpi.h)

See also

HIDP_BUTTON_CAPS

HIDP_LINK_COLLECTION_NODE

HIDP_VALUE_CAPS

HidP_GetButtonCaps

HidP_GetCaps

HidP_GetLinkCollectionNodes

HidP_GetSpecificButtonCaps

HidP_GetSpecificValueCaps

HidP_GetValueCaps