fonction HidP_GetSpecificButtonCaps (hidpi.h)

Article
02/07/2025

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 répondant à un critère de sélection spécifié.

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 en tant que critères 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 en tant que critères 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 un d’utilisation HID en tant que critères de recherche. Si 'utilisation n’est pas zéro, seuls les boutons qui spécifient cette utilisation sont retournés.

[out] ButtonCaps

Pointeur vers une mémoire tampon allouée par l’appelant dans laquelle la routine retourne un tableau de capacité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 à ButtonCaps. En sortie, ce paramètre est défini sur le nombre d’éléments retournés par la routine.

[in] PreparsedData

Pointeur vers un collection de niveau supérieur données préparées.

Valeur de retour

HidP_GetSpecificButtonCaps retourne l’une des valeurs d’état suivantes :

Retourner le code	Description
HIDP_STATUS_SUCCESS	La routine a correctement retourné les données de capacité.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données prédéfinies ne sont pas valides.

Remarques

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

Lorsque vous appelez HidP_GetSpecificButtonCaps, en spécifiant zéro pour UsagePage, Utilisation et LinkCollection équivaut à appeler HidP_GetButtonCaps.

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

Voir également collections HID.

Exigences

Exigence	Valeur
client minimum pris en charge	Disponible dans Windows 2000 et versions ultérieures de Windows.
plateforme cible	Universel
d’en-tête	hidpi.h (include Hidpi.h)
bibliothèque	Hidparse.lib
IRQL	PASSIVE_LEVEL

Voir aussi

Partager via