fonction HidP_GetUsages (hidpi.h)

Article
02/07/2025

La routine HidP_GetUsages retourne une liste de tous les boutons de contrôle HID utilisations qui se trouvent sur une page d’utilisation spécifiée et qui sont définies sur ON dans un rapport HID.

Syntaxe

NTSTATUS HidP_GetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [out]     PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [out]     PCHAR                Report,
  [in]      ULONG                ReportLength
);

Paramètres

[in] ReportType

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

[in] UsagePage

Spécifie la page d’utilisation des utilisations du bouton. La routine retourne uniquement des informations sur les boutons de cette page d’utilisation.

[in] LinkCollection

Spécifie la collection de liens des utilisations du bouton. Si LinkCollection n’est pas zéro, la routine retourne uniquement des informations sur les boutons que contient cette collection de liens ; sinon, si LinkCollection est égal à zéro, la routine retourne des informations sur tous les boutons de la collection de niveau supérieur associée à PreparsedData.

[out] UsageList

Pointeur vers une mémoire tampon allouée par l’appelant que la routine utilise pour retourner les utilisations de tous les boutons définis sur ON et appartenant à la page d’utilisation spécifiée par UsagePage.

[in, out] UsageLength

Spécifie, en entrée, la longueur, dans les éléments de tableau, de la mémoire tampon UsageList. Spécifie, en sortie, le nombre de boutons définis sur ON sur la page d’utilisation spécifiée.

[in] PreparsedData

Pointeur vers le de données prédéfinies d’une collection de niveau supérieur.

[out] Report

Pointeur vers un rapport.

[in] ReportLength

Spécifie la longueur, en octets, du rapport situé à Rapport.

Valeur de retour

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

Retourner le code	Description
HIDP_STATUS_SUCCESS	La routine a correctement retourné toutes les utilisations de bouton définies sur ON.
HIDP_INVALID_REPORT_LENGTH	La longueur du rapport n’est pas valide.
HIDP_INVALID_REPORT_TYPE	Le type de rapport spécifié n’est pas valide.
HIDP_STATUS_BUFFER_TOO_SMALL	La mémoire tampon UsageList est trop petite pour contenir toutes les utilisations actuellement définies sur ON sur la page d’utilisation spécifiée.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	La collection contient des boutons sur la page d’utilisation spécifiée dans un rapport du type spécifié, mais il n’existe pas de telles utilisations dans le rapport spécifié.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données prédéfinies ne sont pas valides.
HIDP_STATUS_USAGE_NOT_FOUND	La collection ne contient aucun bouton sur la page d’utilisation spécifiée dans n’importe quel rapport du type de rapport spécifié.

Remarques

Les applications en mode utilisateur et les pilotes en mode noyau appellent HidP_MaxUsageListLength pour déterminer le nombre maximal de boutons qui peuvent être retournés pour le type de rapport spécifié. Les applications ou pilotes peuvent également appeler HidP_GetUsages et définir (*UsageLength) sur zéro pour retourner la longueur requise dans UsageLength . En d’autres termes, UsageLength doit être un pointeur valide qui pointe vers une valeur ULONG 0 pour obtenir la longueur requise.

Les applications ou les pilotes déterminent la longueur de rapport requise à partir des membres XxxReportByteLength dans la structure HIDP_CAPS d’une collection de niveau supérieur.

Pour plus d’informations, consultez 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	<= DISPATCH_LEVEL