HIDP_BUTTON_CAPS Struktur (hidpi.h)
Die HIDP_BUTTON_CAPS-Struktur enthält Informationen über die Funktion einer HID-Steuerelementschaltfläche Verwendung (oder eine Gruppe von Schaltflächen, die einem Verwendungsbereichzugeordnet sind).
Syntax
typedef struct _HIDP_BUTTON_CAPS {
USAGE UsagePage;
UCHAR ReportID;
BOOLEAN IsAlias;
USHORT BitField;
USHORT LinkCollection;
USAGE LinkUsage;
USAGE LinkUsagePage;
BOOLEAN IsRange;
BOOLEAN IsStringRange;
BOOLEAN IsDesignatorRange;
BOOLEAN IsAbsolute;
USHORT ReportCount;
USHORT Reserved2;
ULONG Reserved[9];
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_BUTTON_CAPS, *PHIDP_BUTTON_CAPS;
Angehörige
UsagePage
Gibt die Verwendungsseite für einen Verwendungsbereich oder einen Verwendungsbereich an.
ReportID
Gibt die Berichts-ID des HID-Berichts an, der den Verwendungs- oder Verwendungsbereich enthält.
IsAlias
Gibt an, ob TRUE, dass eine Schaltfläche eine Reihe von aliasierten Verwendungen. Andernfalls ist IsAliasFALSE, hat die Schaltfläche nur eine Verwendung.
BitField
Enthält die Datenfelder (ein oder zwei Byte), die einem Eingabe-, Ausgabe- oder Feature-Hauptelement zugeordnet sind.
LinkCollection
Gibt den Index der Linkauflistung in der Linksammlungsarray auf oberster Ebene an, die den Verwendungsbereich oder den Verwendungsbereich enthält. Wenn LinkCollection- null ist, ist der Verwendungsbereich oder der Verwendungsbereich in der Sammlung auf oberster Ebene enthalten.
LinkUsage
Gibt die Verwendung der Linkauflistung an, die den Verwendungs- oder Verwendungsbereich enthält. Wenn LinkCollection- null ist, gibt LinkUsage die Verwendung der Auflistung der obersten Ebene an.
LinkUsagePage
Gibt die Verwendungsseite der Linkauflistung an, die den Verwendungs- oder Verwendungsbereich enthält. Wenn LinkCollection- null ist, gibt LinkUsagePage- die Verwendungsseite der Auflistung der obersten Ebene an.
IsRange
Gibt an, wenn TRUE, dass die Struktur einen Verwendungsbereich beschreibt. Andernfalls beschreibt die Struktur eine einzelne Verwendung, wenn IsRangeFALSEist.
IsStringRange
Gibt an, ob TRUE-, dass der Verwendungs- oder Verwendungsbereich über eine Reihe von Zeichenfolgendeskriptoren verfügt. Andernfalls weist IsStringRangeFALSEauf, hat der Verwendungs- oder Verwendungsbereich null oder einen Zeichenfolgendeskriptor.
IsDesignatorRange
Gibt an, ob TRUE, dass der Verwendungsbereich oder der Verwendungsbereich über eine Reihe von Zeichnern verfügt. Andernfalls weist IsDesignatorRangeFALSEauf, hat der Verwendungsbereich oder der Verwendungsbereich null oder einen Kennzeichner.
IsAbsolute
Gibt an, ob TRUE, dass die Schaltflächennutzung oder der Verwendungsbereich absolute Daten bereitstellt. Andernfalls ist IsAbsoluteFALSE, sind die Schaltflächendaten die Änderung des Zustands des vorherigen Werts.
ReportCount
HID-definierte Berichtsanzahl. Verfügbar ab API Version 2.0. Rufen Sie die HIDP_GetVersion-Funktion auf, um die API-Version abzurufen.
Reserved2
Reserviert für die interne Systemverwendung.
Reserved[9]
Reserviert für die interne Systemverwendung.
Range
Gibt an, ob IsRangeTRUE-ist, Informationen zu einem Verwendungsbereich. Andernfalls enthält NotRange Informationen zu einer einzelnen Verwendung, wenn IsRangeFALSEist.
Range.UsageMin
Gibt die inklusive untere Grenze des Verwendungsbereichs an, deren inklusive Obergrenze durch Range.UsageMaxangegeben wird.
Range.UsageMax
Gibt die inklusive obere Grenze eines Verwendungsbereichs an, deren inklusive untere Grenze durch Range.UsageMinangegeben wird.
Range.StringMin
Gibt die inklusive untere Grenze eines Bereichs von Zeichenfolgendeskriptoren an (angegeben durch Zeichenfolgen-Minimum- und Zeichenfolgenhöchstwerte), deren inklusive obere Grenze durch Range.StringMaxangegeben wird.
Range.StringMax
Gibt die inklusive obere Grenze eines Bereichs von Zeichenfolgendeskriptoren (angegeben durch Zeichenfolgen-Minimum- und Zeichenfolgenhöchstwerte) an, deren inklusive untere Grenze durch Range.StringMinangegeben wird.
Range.DesignatorMin
Gibt die inklusive untere Grenze eines Bereichs von Zeichnern an (angegeben durch designator minimum and designator maximum items), deren inklusive untere Grenze durch Range.DesignatorMaxangegeben wird.
Range.DesignatorMax
Gibt die inklusive obere Grenze eines Bereichs von Zeichnern an (angegeben durch designator minimum and designator maximum items), deren inklusive untere Grenze durch Range.DesignatorMinangegeben wird.
Range.DataIndexMin
Gibt die inklusive untere Grenze eines sequenziellen Bereichs von Datenindizes an, die 1:1 und in derselben Reihenfolge entsprechen, den durch den Verwendungsbereich angegebenen Verwendungen Range.UsageMinRange.UsageMax.
Range.DataIndexMax
Gibt die inklusive obere Grenze eines sequenziellen Datenindizes an, die 1:1 und in derselben Reihenfolge entsprechen, den durch den Verwendungsbereich angegebenen Verwendungen Range.UsageMinRange.UsageMax.
NotRange
Gibt an, ob IsRangeFALSE-ist, Informationen zu einer einzelnen Verwendung. Andernfalls enthält Range Informationen zu einem Verwendungsbereich, wenn IsRangeTRUEist.
NotRange.Usage
Gibt eine Verwendungs-IDan.
NotRange.Reserved1
Reserviert für die interne Systemverwendung.
NotRange.StringIndex
Gibt eine Zeichenfolgenbeschreibungs-ID für die durch NotRange.Usageangegebene Verwendung an.
NotRange.Reserved2
Reserviert für die interne Systemverwendung.
NotRange.DesignatorIndex
Gibt eine Kennzeichner-ID für die durch NotRange.Usageangegebene Verwendung an.
NotRange.Reserved3
Reserviert für die interne Systemverwendung.
NotRange.DataIndex
Gibt den Datenindex der durch NotRange.Usageangegebenen Verwendung an.
NotRange.Reserved4
Reserviert für die interne Systemverwendung.
Bemerkungen
Clients erhalten ein Schaltflächenfunktionsarray durch Aufrufen von HidP_GetButtonCaps oder HidP_GetSpecificButtonCaps. Diese Routinen geben ein Array von HIDP_BUTTON_CAPS Strukturen in einem vom Aufrufer zugewiesenen Puffer zurück. Die erforderliche Pufferlänge wird in der HIDP_CAPS Struktur angegeben, die von HidP_GetCapszurückgegeben wird.
Informationen zu den Funktionen von HID-Steuerelementwerten finden Sie unter Collection Capability und Value Capability Arrays.
Wenn ein Berichtsdeskriptor ein Eingabe-, Ausgabe- oder Featurehauptelement mit weniger Verwendungsdeklarationen als der ReportCountdeklariert, gilt die letzte Verwendung für alle verbleibenden nicht angegebenen Anzahl in diesem Hauptelement. Beispielsweise verfügen Sie möglicherweise über Daten, die viele Felder beschreiben müssen, möglicherweise gepufferte Bytes. In diesem Fall wird nur eine Großbuchstabenstruktur für diese zugeordneten Felder zugeordnet, alle mit derselben Verwendung, und ReportCount die Anzahl der beteiligten Felder widerspiegelt. Normalerweise ist ReportCount- eins. Für den Zugriff auf alle Felder in einer solchen Wertstruktur wäre die Verwendung von HidP_GetUsageValueArray und HidP_SetUsageValueArrayerforderlich. Die funktionen HidP_GetUsageValue und HidP_SetScaledUsageValue funktionieren ebenfalls. Diese Funktionen funktionieren jedoch nur mit dem ersten Feld der Struktur.
Anforderungen
| Anforderung | Wert |
|---|---|
| Header- | hidpi.h (include Hidpi.h) |