Edit

HIDP_COLLECTION_DESC structure (hidpddi.h)

  • Article

Contains the information of a top-level-collection. This structure is used in the HidP_GetCollectionDescription call.

Syntax

typedef struct _HIDP_COLLECTION_DESC {
  USAGE                UsagePage;
  USAGE                Usage;
  UCHAR                CollectionNumber;
  UCHAR                Reserved[15];
  USHORT               InputLength;
  USHORT               OutputLength;
  USHORT               FeatureLength;
  USHORT               PreparsedDataLength;
  PHIDP_PREPARSED_DATA PreparsedData;
} HIDP_COLLECTION_DESC, *PHIDP_COLLECTION_DESC;

Members

UsagePage

Specifies the usage page of the usage ID specified by Usage.

Usage

Indicates a usage ID.

CollectionNumber

The index of the collection in the array of HIDP_COLLECTION_DESC structure. This is a 1-based value.

Reserved[15]

Reserved for internal system use. Must be 0.

InputLength

The maximum length of an input report of this collection.

OutputLength

The maximum length of an output report of this collection.

FeatureLength

The maximum length of a feature report of this collection.

PreparsedDataLength

The length of the preparsed data pointed to by PreparsedData.

PreparsedData

A pointer to a _HIDP_PREPARSED_DATA structure that contains a top-level collection's preparsed data.

Requirements

Requirement Value
Header hidpddi.h (include Hidpddi.h)

See also

HidP_GetCollectionDescription