fonction HidP_GetData (hidpi.h)

Article
02/26/2024

La routine HidP_GetData retourne, pour un rapport spécifié, un tableau de structures HIDP_DATA qui identifient les index de données de tous les boutons de contrôle HID actuellement définis sur ON (1), ainsi que les index de données et les données associées à toutes les valeurs de contrôle HID.

Syntaxe

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Paramètres

[in] ReportType

Spécifie une valeur d’énumérateur HIDP_REPORT_TYPE qui indique le type de rapport HID situé dans Rapport.

[out] DataList

Spécifie un tableau alloué par l’appelant de structures de HIDP_DATA que la routine utilise pour retourner des informations sur tous les boutons actuellement définis sur ON et les données associées aux valeurs.

[in, out] DataLength

Spécifie, en entrée, le nombre de structures que le tableau DataList alloué à l’appelant contient. Spécifie, lors de la sortie, le nombre de contrôles pour lesquels la routine peut retourner des données, ce qui inclut tous les boutons actuellement définis sur ON et toutes les valeurs de contrôle.

[in] PreparsedData

Pointeur vers les données préparées de la collection de niveau supérieur associée au rapport HID situé dans Rapport.

[in] Report

Pointeur vers un rapport HID.

[in] ReportLength

Spécifie la taille, en octets, du rapport HID situé dans Rapport, qui doit être égale à la longueur du rapport pour le type de rapport spécifié retourné par HidP_GetCaps dans la structure HIDP_CAPS de la collection.

Valeur retournée

HidP_GetData retourne l’une des valeurs status suivantes :

Code de retour	Description
HIDP_STATUS_SUCCESS	Toutes les données de contrôle ont été retournées.
HIDP_STATUS_INVALID_REPORT_TYPE	Le type de rapport spécifié par ReportType n’est pas valide
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées spécifiées par PreparsedData ne sont pas valides
HIDP_STATUS_INVALID_REPORT_LENGTH	La taille, en octets, du rapport HID n’est pas égale à la longueur spécifiée dans la structure HIDP_CAPS de la collection pour le type de rapport spécifié.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	La collection de niveau supérieur n’a pas de rapport du type spécifié.
HIDP_STATUS_BUFFER_TOO_SMALL	Le tableau DataList est trop petit pour décrire tous les boutons, actuellement définis sur ON, et toutes les valeurs du rapport HID.

Remarques

Les applications en mode utilisateur et les pilotes en mode noyau appellent HidP_MaxDataListLength pour déterminer le nombre maximal possible de structures HIDP_DATA que HidP_GetData peuvent retourner.

HidP_GetData ne retourne pas de données pour les tableaux de valeurs d’utilisation.

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

Voir aussi

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA

Partager via