structure HIDP_BUTTON_CAPS (hidpi.h)
La structure HIDP_BUTTON_CAPS contient des informations sur la capacité d’un bouton de contrôle HID d’utilisation (ou un ensemble de boutons associés à une plage d’utilisation ).
Syntaxe
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;
Membres
UsagePage
Spécifie la page d’utilisation pour une plage d’utilisation ou d’utilisation.
ReportID
Spécifie l’ID de rapport du rapport HID qui contient l’utilisation ou la plage d’utilisation.
IsAlias
Indique, si TRUE, qu’un bouton a un ensemble d’utilisations alias . Sinon, si IsAlias est FAUX, le bouton n’a qu’une seule utilisation.
BitField
Contient les champs de données (un ou deux octets) associés à un élément principal d’entrée, de sortie ou de fonctionnalité.
LinkCollection
Spécifie l’index de la collection de liens dans une collection de de niveau supérieurtableau de collections de liens qui contient l’utilisation ou la plage d’utilisation. Si LinkCollection est égal à zéro, l’utilisation ou la plage d’utilisation est contenue dans la collection de niveau supérieur.
LinkUsage
Spécifie l’utilisation de la collection de liens qui contient l’utilisation ou la plage d’utilisation. Si LinkCollection est égal à zéro, LinkUsage spécifie l’utilisation de la collection de niveau supérieur.
LinkUsagePage
Spécifie la page d’utilisation de la collection de liens qui contient l’utilisation ou la plage d’utilisation. Si LinkCollection est égal à zéro, LinkUsagePage spécifie la page d’utilisation de la collection de niveau supérieur.
IsRange
Spécifie, si TRUE, que la structure décrit une plage d’utilisation. Sinon, si IsRange est faux, la structure décrit une utilisation unique.
IsStringRange
Spécifie, si TRUE, que l’utilisation ou la plage d’utilisation a un ensemble de descripteurs de chaîne. Sinon, si IsStringRange est faux, l’utilisation ou la plage d’utilisation a zéro ou un descripteur de chaîne.
IsDesignatorRange
Spécifie, si TRUE, que l’utilisation ou la plage d’utilisation a un ensemble d’indicateurs. Sinon, si IsDesignatorRange est FALSE, l’utilisation ou la plage d’utilisation a zéro ou un indicateur.
IsAbsolute
Spécifie, si TRUE, que l’utilisation du bouton ou la plage d’utilisation fournit des données absolues. Dans le cas contraire, si IsAbsolute est FALSE, les données du bouton sont le changement d’état de la valeur précédente.
ReportCount
Nombre de rapports définis par HID. Disponible à partir de la version 2.0 de l’API. Appelez la fonction HIDP_GetVersion pour obtenir la version de l’API.
Reserved2
Réservé à une utilisation interne du système.
Reserved[9]
Réservé à une utilisation interne du système.
Range
Spécifie, si IsRange est TRUE, informations sur une plage d’utilisation. Sinon, si IsRange est FAUX, NotRange contient des informations sur une seule utilisation.
Range.UsageMin
Indique la limite inférieure inclusive de la plage d’utilisation dont la limite supérieure inclusive est spécifiée par Range.UsageMax.
Range.UsageMax
Indique la limite supérieure inclusive d’une plage d’utilisation dont la limite inférieure inclusive est indiquée par Range.UsageMin.
Range.StringMin
Indique la limite inférieure inclusive d’une plage de descripteurs de chaîne (spécifiée par les éléments de chaîne minimum et de chaîne maximum) dont la limite supérieure inclusive est indiquée par Range.StringMax.
Range.StringMax
Indique la limite supérieure inclusive d’une plage de descripteurs de chaîne (spécifiée par les éléments minimum de chaîne et le nombre maximal de chaînes) dont la limite inférieure inclusive est indiquée par Range.StringMin.
Range.DesignatorMin
Indique la limite inférieure inclusive d’une plage d’indicateurs (spécifiée par les éléments minimum et d’indicateur maximum de l’indicateur) dont la limite inférieure inclusive est indiquée par Range.DesignatorMax.
Range.DesignatorMax
Indique la limite supérieure inclusive d’une plage de pointeurs (spécifiée par les éléments minimum et de l’indicateur maximum de l’indicateur) dont la limite inférieure inclusive est indiquée par Range.DesignatorMin.
Range.DataIndexMin
Indique la limite inférieure inclusive d’une plage séquentielle d’index de données qui correspondent, un-à-un et dans le même ordre, aux utilisations spécifiées par la plage d’utilisation Range.UsageMin à Range.UsageMax.
Range.DataIndexMax
Indique la limite supérieure inclusive d’une plage séquentielle d’index de données qui correspondent, un-à-un et dans le même ordre, aux utilisations spécifiées par la plage d’utilisation Range.UsageMin à Range.UsageMax.
NotRange
Spécifie, si IsRange est faux, informations sur une seule utilisation. Sinon, si IsRange est TRUE, Plage contient des informations sur une plage d’utilisation.
NotRange.Usage
NotRange.Reserved1
Réservé à une utilisation interne du système.
NotRange.StringIndex
Indique un ID de descripteur de chaîne pour l’utilisation spécifiée par NotRange.Usage.
NotRange.Reserved2
Réservé à une utilisation interne du système.
NotRange.DesignatorIndex
Indique un ID d’indicateur pour l’utilisation spécifiée par NotRange.Usage.
NotRange.Reserved3
Réservé à une utilisation interne du système.
NotRange.DataIndex
Indique l’index de données de l’utilisation spécifiée par NotRange.Usage.
NotRange.Reserved4
Réservé à une utilisation interne du système.
Remarques
Les clients obtiennent un tableau de fonctionnalités de bouton en appelant HidP_GetButtonCaps ou HidP_GetSpecificButtonCaps. Ces routines retournent un tableau de structures HIDP_BUTTON_CAPS dans une mémoire tampon allouée par l’appelant. La longueur de mémoire tampon requise est spécifiée dans la structure HIDP_CAPS retournée par HidP_GetCaps.
Pour plus d’informations sur les fonctionnalités des valeurs de contrôle HID, consultez fonctionnalité de collecte et matrices de capacités de valeur.
Lorsqu’un descripteur de rapport déclare un élément principal d’entrée, de sortie ou de fonctionnalité avec moins de déclarations d’utilisation que le ReportCount, la dernière utilisation s’applique à tous les nombres restants non spécifiés dans cet élément principal. Par exemple, vous pouvez avoir des données qui nécessitaient de nombreux champs pour décrire, éventuellement des octets mis en mémoire tampon. Dans ce cas, une seule structure de limite de valeur est allouée pour ces champs associés, toutes avec la même utilisation et ReportCount reflète le nombre de champs impliqués. Normalement, ReportCount est un. Pour accéder à tous les champs d’une telle structure de valeur, il faudrait utiliser HidP_GetUsageValueArray et HidP_SetUsageValueArray. Les fonctions HidP_GetUsageValue et HidP_SetScaledUsageValue fonctionnent également. Toutefois, ces fonctions fonctionnent uniquement avec le premier champ de la structure.
Exigences
| Exigence | Valeur |
|---|---|
| d’en-tête | hidpi.h (include Hidpi.h) |