HIDP_CAPS (Compact 2013)

3/26/2014

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

Syntax

typedef struct _HIDP_CAPS {
  USAGE Usage;
  USAGE UsagePage;
  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

• Usage
  Top-level collection's usage identifier.

• UsagePage
  Top-level collection's usage page.

• InputReportByteLength
  Maximum size, in bytes, of the input reports, including the report identifier, if report identifiers are used, which is added to the beginning of the report data.

• OutputReportByteLength
  Maximum size, in bytes, of all the output reports, including the report identifier, if report identifiers are used, which is added to the beginning of the report data.

• FeatureReportByteLength
  Maximum length, in bytes, of all the feature reports, including the report identifier, if report identifiers are used, which is added to the beginning of the report data.

• Reserved
  Reserved.

• NumberLinkCollectionNodes
  Number of HIDP_LINK_COLLECTION_NODE structures that are returned for this top-level collection by HidP_GetLinkCollectionNodes.

• NumberInputButtonCaps
  Number of input HIDP_BUTTON_CAPS structures that HidP_GetButtonCaps returns.

• NumberInputValueCaps
  Number of input HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

• NumberInputDataIndices
  Number of data indexes assigned to buttons and values in all input reports.

• NumberOutputButtonCaps
  Number of output HIDP_BUTTON_CAPS structures that HidP_GetButtonCaps returns.

• NumberOutputValueCaps
  Number of output HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

• NumberOutputDataIndices
  Number of data indexes assigned to buttons and values in all output reports.

• NumberFeatureButtonCaps
  Total number of feature HIDP_BUTTONS_CAPS structures that HidP_GetButtonCaps returns

• NumberFeatureValueCaps
  Total number of feature HIDP_VALUE_CAPS structures that HidP_GetValueCaps returns.

• NumberFeatureDataIndices
  Number of data indexes assigned to buttons and values in all feature reports.

Remarks

Callers of the HID class support functions use the information provided in this structure when a called function 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 indexes.

Requirements

Header

hidpi.h

See Also

Reference

HID Parser Structures
HIDP_BUTTON_CAPS
HidP_GetCaps
HidP_GetButtonCaps
HidP_GetLinkCollectionNodes
HidP_GetSpecificButtonCaps
HidP_GetSpecificValueCaps
HidP_GetValueCaps
HIDP_LINK_COLLECTION_NODE
HIDP_VALUE_CAPS