HidP_InitializeReportForID, fonction (hidpi.h)

Article
08/07/2023

La routine HidP_InitializeReportForID initialise un rapport HID.

Syntaxe

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

Paramètres

[in] ReportType

Spécifie un énumérateur HIDP_REPORT_TYPE qui indique le type de rapport HID situé dans Rapport.

[in] ReportID

Spécifie un ID de rapport.

[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.

[out] Report

Pointeur vers la mémoire tampon allouée à l’appelant contenant le rapport HID qui HidP_InitializeReportForID initialise.

[in] ReportLength

Spécifie la taille, en octets, du rapport HID situé dans Rapport. ReportLength doit être égal à la longueur de rapport de la collection pour le type de rapport spécifié, comme spécifié par les membres XxxReportByteLength de la structure HIDP_CAPS d’une collection.

Valeur retournée

HidP_InitializeReportForID retourne l’une des valeurs status suivantes :

Code de retour	Description
HIDP_STATUS_SUCCESS	Le rapport a été initialisé avec succès.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées ne sont pas valides.
HIDP_STATUS_INVALID_REPORT_LENGTH	La longueur spécifiée du rapport n’est pas égale à la longueur de rapport de la collection pour le type de rapport spécifié.
HIDP_STATUS_INVALID_REPORT_TYPE	Le type de rapport n’est pas valide.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	L’ID de rapport spécifié n’est pas valide.

Remarques

L’initialisation d’un rapport HID définit toutes les données de contrôle sur zéro ou sur la valeur null d’un contrôle, comme défini par la norme USB HID. (L’envoi ou la réception d’une valeur Null indique que la valeur actuelle d’un contrôle ne doit pas être modifiée.)

HidP_InitializeReportForID effectue les opérations suivantes :

Définit sur zéro les champs de bits de tous les boutons et valeurs sans valeurs Null.
Définit le champ de bits de tous les contrôles avec des valeurs Null sur leur valeur null correspondante.

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

Partager via