HIDP_VALUE_CAPS 構造体 (hidpi.h)

[アーティクル]
08/07/2023

HIDP_VALUE_CAPS構造体には、HID コントロール値のセット (単一の使用状況または使用範囲) の機能を説明する情報が含まれています。

構文

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;

メンバー

UsagePage

使用状況または使用範囲の使用状況ページを指定します。

ReportID

使用状況または使用状況の範囲を含む HID レポートのレポート ID を指定します。

IsAlias

TRUE の場合、使用法が一連のエイリアス化された使用法のメンバーであることを示します。それ以外の場合 、IsAlias が FALSE の場合、値の使用法は 1 つだけです。

BitField

入力、出力、または機能メイン項目に関連付けられているデータフィールド (1 バイトまたは 2 バイト) が含まれます。

LinkCollection

使用法または使用範囲を含む最上位のコレクションのリンクコレクション配列内のリンクコレクションのインデックスを指定します。 LinkCollection が 0 の場合、使用法または使用範囲は最上位のコレクションに含まれます。

LinkUsage

使用状況または使用範囲を含むリンクコレクションの使用法を指定します。 LinkCollection が 0 の場合、LinkUsage は最上位のコレクションの使用法を指定します。

LinkUsagePage

使用状況または使用範囲を含むリンクコレクションの使用状況ページを指定します。 LinkCollection が 0 の場合、LinkUsagePage は最上位のコレクションの使用法ページを指定します。

IsRange

TRUE の場合、構造体が使用範囲を記述することを指定します。それ以外の場合 、IsRange が FALSE の場合、構造体は 1 つの使用法を記述します。

IsStringRange

TRUE の場合、使用範囲または使用範囲に一連の文字列記述子があることを指定します。それ以外の場合、 IsStringRange が FALSE の場合、使用範囲または使用範囲には 0 個または 1 個の文字列記述子があります。

IsDesignatorRange

使用範囲または使用範囲に一連の指定子があることを TRUE の場合に指定します。それ以外の場合 、IsDesignatorRange が FALSE の場合、使用範囲または使用範囲には 0 個または 1 つの指定子があります。

IsAbsolute

使用範囲または使用範囲が絶対データを提供することを TRUE の場合に指定します。それ以外の場合 、IsAbsolute が FALSE の場合、値は前の値からの状態の変化になります。

HasNull

TRUE の場合、使用状況が NULL 値をサポートすることを指定します。これは、データが有効でないことを示し、無視する必要があることを示します。それ以外の場合 、HasNull が FALSE の場合、使用法には NULL 値はありません。

Reserved

内部システム用に予約されています。

BitSize

レポート内の使用状況のデータフィールドのサイズをビット単位で指定します。 ReportCount が 1 より大きい場合、各使用状況には、このサイズの個別のデータフィールドがあります。

ReportCount

この構造体で説明する使用量の数を指定します。

Reserved2[5]

内部システム用に予約されています。

UnitsExp

USB HID 標準で説明されているように、使用法の指数を指定します。

Units

USB HID Standard で説明されているように、使用量の単位を指定します。

LogicalMin

使用法の符号付き下限を指定します。

LogicalMax

使用法の符号付き上限を指定します。

PhysicalMin

スケーリングが論理最小値に適用された後の使用量の符号付き下限を指定します。

PhysicalMax

スケーリングが論理最大値に適用された後の使用量の符号付き上限を指定します。

Range

IsRange が TRUE の場合は、使用範囲に関する情報を指定します。それ以外の場合、 IsRange が FALSE の場合、 NotRange には単一の使用状況に関する情報が含まれます。

Range.UsageMin

Range.UsageMax で指定された包括的な上限を持つ、使用範囲の包括的な下限を示します。

Range.UsageMax

Range.UsageMin で示される包括的な下限を持つ、使用範囲の包括的な上限を示します。

Range.StringMin

範囲の上限が Range.StringMax で示される文字列記述子の範囲 (文字列の最小値と文字列の最大項目で指定) の包括的な下限を示します。

Range.StringMax

範囲の下限が Range.StringMin で示される文字列記述子の範囲 (文字列の最小項目と文字列の最大項目で指定) の包括的な上限を示します。

Range.DesignatorMin

Range.DesignatorMax で示される指定子の範囲 (指定子の最小項目と指定子の最大項目で指定) の包括的下限を示します。

Range.DesignatorMax

Range.DesignatorMin で示される指定子の範囲の包括的な上限 (指定子の最小項目と指定子の最大項目で指定) を示します。

Range.DataIndexMin

使用範囲 Range.UsageMin から Range.UsageMax に指定された使用量に一対一で、同じ順序で対応するデータインデックスのシーケンシャル範囲の包括的な下限を示します。

Range.DataIndexMax

使用範囲 Range.UsageMin から Range.UsageMax に指定された使用量に一対一で、同じ順序で対応するデータインデックスのシーケンシャル範囲の包括的な上限を示します。

NotRange

IsRange が FALSE の場合、単一の使用状況に関する情報を指定します。それ以外の場合 、IsRange が TRUE の場合、 Range には使用範囲に関する情報が含まれます。

NotRange.Usage

使用状況 ID を示します。

NotRange.Reserved1

内部システム用に予約されています。

NotRange.StringIndex

NotRange.Usage で指定された使用法の文字列記述子 ID を示します。

NotRange.Reserved2

内部システム用に予約されています。

NotRange.DesignatorIndex

NotRange.Usage で指定された使用法の指定子 ID を示します。

NotRange.Reserved3

内部システム用に予約されています。

NotRange.DataIndex

NotRange.Usage で指定された使用状況のデータインデックスを示します。

NotRange.Reserved4

内部システム用に予約されています。

注釈

クライアントは、HidP_GetValueCapsまたはHidP_GetSpecificValueCapsを呼び出して値機能配列を取得します。これらのルーチンは、呼び出し元によって割り当てられたバッファー内のHIDP_VALUE_CAPS構造体の配列を返します。必要なバッファー長は、HidP_GetCapsによって返されるHIDP_CAPS構造体で指定されます。

HID コントロール値の機能の詳細については、「コレクション機能と値の機能配列」を参照してください。