fonction HidP_GetButtonCaps (hidpi.h)

Article
02/26/2024

La routine HidP_GetButtonCaps retourne un tableau de fonctionnalités de bouton qui décrit tous les boutons de contrôle HID d’une collection de niveau supérieur pour un type spécifié de rapport HID.

Syntaxe

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Paramètres

[in] ReportType

Spécifie une valeur d’énumérateur HIDP_REPORT_TYPE qui identifie le type de rapport.

[out] ButtonCaps

Pointeur vers une mémoire tampon allouée à l’appelant que la routine utilise pour retourner un tableau de fonctionnalités de bouton pour le type de rapport spécifié.

[in, out] ButtonCapsLength

Spécifie la longueur de l’entrée, dans les éléments de tableau, de la mémoire tampon fournie dans ButtonCaps. Sur la sortie, ce paramètre est défini sur le nombre réel d’éléments que la routine retourne.

[in] PreparsedData

Pointeur vers les données préparées d’une collection de niveau supérieur.

Valeur retournée

HidP_GetButtonCaps retourne l’une des valeurs status suivantes :

Code de retour	Description
HIDP_STATUS_SUCCESS	La routine a correctement retourné les données de fonctionnalité.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées ne sont pas valides.

Remarques

HidP_GetButtonCaps retourne la fonctionnalité de tous les boutons d’une collection de niveau supérieur pour un type de rapport spécifié.

ButtonCapsLength doit être défini sur la valeur du membre NumberXxxButtonCaps de la structure HIDP_CAPS retournée par HidP_GetCaps, où Xxx spécifie le type de rapport.

Pour obtenir un sous-ensemble de fonctionnalités de bouton, sélectionnés par utilisation, page d’utilisation ou collection de liens, utilisez HidP_GetSpecificButtonCaps.

Pour plus d’informations sur la fonctionnalité d’une collection, consultez Obtention d’informations de collection.

Voir aussi Les collections HID.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows 2000 et versions ultérieures de Windows.
Plateforme cible	Universal
En-tête	hidpi.h (inclure Hidpi.h)
Bibliothèque	Hidparse.lib
IRQL	PASSIVE_LEVEL

Voir aussi

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA

Partager via