Edit

HIDP_LINK_COLLECTION_NODE structure (hidpi.h)

  • Article

The HIDP_LINK_COLLECTION_NODE structure contains information about a link collection in a top-level collection's link collection array.

Syntax

typedef struct _HIDP_LINK_COLLECTION_NODE {
  USAGE  LinkUsage;
  USAGE  LinkUsagePage;
  USHORT Parent;
  USHORT NumberOfChildren;
  USHORT NextSibling;
  USHORT FirstChild;
  ULONG  CollectionType : 8;
  ULONG  IsAlias : 1;
  ULONG  Reserved : 23;
  PVOID  UserContext;
} HIDP_LINK_COLLECTION_NODE, *PHIDP_LINK_COLLECTION_NODE;

Members

LinkUsage

Specifies the usage ID of a top-level collection.

LinkUsagePage

Specifies the usage page of the collection.

Parent

Specifies the index of the collection's parent collection. If the collection has no parent, Parent is zero.

NumberOfChildren

Specifies the number of child collections that the collection contains.

NextSibling

Specifies the index of the collection's immediate sibling. If the collection has no sibling, NextSibling is zero.

FirstChild

Specifies the index of the collection's first child collection. If the collection has no children, FirstChild is zero.

CollectionType

Specifies the type of collection item.

IsAlias

Specifies, if TRUE, that this collection is an aliased collection. Otherwise, if FALSE, the collection is not aliased.

Reserved

Reserved for internal system use.

UserContext

Pointer to application-specific information.

Remarks

The HidP_GetLinkCollectionNodes routine returns a top-level collection's link collection array. The indices specified in a link collection node are indices in the collection's link collection array.

Requirements

Requirement Value
Header hidpi.h (include Hidpi.h)

See also

HIDP_BUTTON_CAPS

HIDP_VALUE_CAPS

HidP_GetLinkCollectionNodes