HidP_GetSpecificButtonCaps, fonction (hidpi.h)

Article
08/07/2023

La routine HidP_GetSpecificButtonCaps 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 qui répondent à des critères de sélection spécifiés.

Syntaxe

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [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.

[in] UsagePage

Spécifie une page d’utilisation comme critère de recherche. Si UsagePage n’est pas zéro, seuls les boutons qui spécifient cette page d’utilisation sont retournés.

[in] LinkCollection

Spécifie une collection de liens comme critère de recherche. Si LinkCollection n’est pas zéro, seuls les boutons qui font partie de cette collection de liens sont retournés.

[in] Usage

Spécifie une utilisation hid comme critère de recherche. Si l’utilisation est différente de zéro, seuls les boutons qui spécifient cette utilisation sont retournés.

[out] ButtonCaps

Pointeur vers une mémoire tampon allouée à l’appelant dans laquelle la routine retourne 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. Lors de la sortie, ce paramètre est défini sur le nombre d’éléments que la routine a réellement retournés.

[in] PreparsedData

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

Valeur retournée

HidP_GetSpecificButtonCaps retourne l’une des valeurs status suivantes :

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

Remarques

La taille requise du tableau ButtonCaps est spécifiée par les membres NumberXxxButtonCaps de la structure HIDP_CAPS d’une collection de niveau supérieur.

Lorsque vous appelez HidP_GetSpecificButtonCaps, la spécification de zéro pour UsagePage, Usage et LinkCollection équivaut à appeler HidP_GetButtonCaps.

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

Voir aussi 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

Partager via