Export (0) Print
Expand All

HIDP_VALUE_CAPS structure

The HIDP_VALUE_CAPS structure contains information that describes the capability of a set of HID control values (either a single usage or a usage range).

Syntax


typedef struct _HIDP_VALUE_CAPS {
  USAGE   UsagePage;
  UCHAR   ReportID;
  BOOLEAN IsAlias;
  USHORT  BitField;
  USHORT  LinkCollection;
  USAGE   LinkUsage;
  USAGE   LinkUsagePage;
  BOOLEAN IsRange;
  BOOLEAN IsStringRange;
  BOOLEAN IsDesignatorRange;
  BOOLEAN IsAbsolute;
  BOOLEAN HasNull;
  UCHAR   Reserved;
  USHORT  BitSize;
  USHORT  ReportCount;
  USHORT  Reserved2[5];
  ULONG   UnitsExp;
  ULONG   Units;
  LONG    LogicalMin;
  LONG    LogicalMax;
  LONG    PhysicalMin;
  LONG    PhysicalMax;
  union {
    struct {
      USAGE  UsageMin;
      USAGE  UsageMax;
      USHORT StringMin;
      USHORT StringMax;
      USHORT DesignatorMin;
      USHORT DesignatorMax;
      USHORT DataIndexMin;
      USHORT DataIndexMax;
    } Range;
    struct {
      USAGE  Usage;
      USAGE  Reserved1;
      USHORT StringIndex;
      USHORT Reserved2;
      USHORT DesignatorIndex;
      USHORT Reserved3;
      USHORT DataIndex;
      USHORT Reserved4;
    } NotRange;
  };
} HIDP_VALUE_CAPS, *PHIDP_VALUE_CAPS;

Members

UsagePage

Specifies the usage page of the usage or usage range.

ReportID

Specifies the report ID of the HID report that contains the usage or usage range.

IsAlias

Indicates, if TRUE, that the usage is member of a set of aliased usages. Otherwise, if IsAlias is FALSE, the value has only one usage.

BitField

Contains the data fields (one or two bytes) associated with an input, output, or feature main item.

LinkCollection

Specifies the index of the link collection in a top-level collection's link collection array that contains the usage or usage range. If LinkCollection is zero, the usage or usage range is contained in the top-level collection.

LinkUsage

Specifies the usage of the link collection that contains the usage or usage range. If LinkCollection is zero, LinkUsage specifies the usage of the top-level collection.

LinkUsagePage

Specifies the usage page of the link collection that contains the usage or usage range. If LinkCollection is zero, LinkUsagePage specifies the usage page of the top-level collection.

IsRange

Specifies, if TRUE, that the structure describes a usage range. Otherwise, if IsRange is FALSE, the structure describes a single usage.

IsStringRange

Specifies, if TRUE, that the usage or usage range has a set of string descriptors. Otherwise, if IsStringRange is FALSE, the usage or usage range has zero or one string descriptor.

IsDesignatorRange

Specifies, if TRUE, that the usage or usage range has a set of designators. Otherwise, if IsDesignatorRange is FALSE, the usage or usage range has zero or one designator.

IsAbsolute

Specifies, if TRUE, that the usage or usage range provides absolute data. Otherwise, if IsAbsolute is FALSE, the value is the change in state from the previous value.

HasNull

Specifies, if TRUE, that the usage supports a NULL value, which indicates that the data is not valid and should be ignored. Otherwise, if HasNull is FALSE, the usage does not have a NULL value.

Reserved

Reserved for internal system use.

BitSize

Specifies the size, in bits, of a usage's data field in a report. If ReportCount is greater than one, each usage has a separate data field of this size.

ReportCount

Specifies the number of usages that this structure describes.

Reserved2

Reserved for internal system use.

UnitsExp

Specifies the usage's exponent, as described by the USB HID standard.

Units

Specifies the usage's units, as described by the USB HID Standard.

LogicalMin

Specifies a usage's signed lower bound.

LogicalMax

Specifies a usage's signed upper bound.

PhysicalMin

Specifies a usage's signed lower bound after scaling is applied to the logical minimum value.

PhysicalMax

Specifies a usage's signed upper bound after scaling is applied to the logical maximum value.

Range

Specifies, if IsRange is TRUE, information about a usage range. Otherwise, if IsRange is FALSE, NotRange contains information about a single usage.

UsageMin

Indicates the inclusive lower bound of usage range whose inclusive upper bound is specified by Range.UsageMax.

UsageMax

Indicates the inclusive upper bound of a usage range whose inclusive lower bound is indicated by Range.UsageMin.

StringMin

Indicates the inclusive lower bound of a range of string descriptors (specified by string minimum and string maximum items) whose inclusive upper bound is indicated by Range.StringMax.

StringMax

Indicates the inclusive upper bound of a range of string descriptors (specified by string minimum and string maximum items) whose inclusive lower bound is indicated by Range.StringMin.

DesignatorMin

Indicates the inclusive lower bound of a range of designators (specified by designator minimum and designator maximum items) whose inclusive lower bound is indicated by Range.DesignatorMax.

DesignatorMax

Indicates the inclusive upper bound of a range of designators (specified by designator minimum and designator maximum items) whose inclusive lower bound is indicated by Range.DesignatorMin.

DataIndexMin

Indicates the inclusive lower bound of a sequential range of data indices that correspond, one-to-one and in the same order, to the usages specified by the usage range Range.UsageMin to Range.UsageMax.

DataIndexMax

Indicates the inclusive upper bound of a sequential range of data indices that correspond, one-to-one and in the same order, to the usages specified by the usage range Range.UsageMin to Range.UsageMax.

NotRange

Specifies, if IsRange is FALSE, information about a single usage. Otherwise, if IsRange is TRUE, Range contains information about a usage range.

Usage

Indicates a usage ID.

Reserved1

Reserved for internal system use.

StringIndex

Indicates a string descriptor ID for the usage specified by NotRange.Usage.

Reserved2

Reserved for internal system use.

DesignatorIndex

Indicates a designator ID for the usage specified by NotRange.Usage.

Reserved3

Reserved for internal system use.

DataIndex

Indicates the data index of the usage specified by NotRange.Usage.

Reserved4

Reserved for internal system use.

Remarks

Clients obtain a value capability array by calling HidP_GetValueCaps or HidP_GetSpecificValueCaps. These routines return an array of HIDP_VALUE_CAPS structures in a caller-allocated buffer. The required buffer length is specified in the HIDP_CAPS structure returned by HidP_GetCaps.

For information about the capabilities of HID control values, see Collection Capability and Value Capability Arrays.

Requirements

Header

Hidpi.h (include Hidpi.h)

See also

HidP_GetButtonCaps
HidP_GetSpecificButtonCaps
HidP_GetSpecificValueCaps
HidP_GetUsageValue
HidP_GetUsageValueArray
HidP_GetValueCaps
HidP_GetCaps
HIDP_CAPS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft