fonction HidP_InitializeReportForID (hidpi.h)
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é à 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é à rapport .
[out] Report
Pointeur vers la mémoire tampon allouée par l’appelant contenant le rapport HID qui HidP_InitializeReportForID initialise.
[in] ReportLength
Spécifie la taille, en octets, du rapport HID situé à rapport. ReportLength doit être égal à la longueur de rapport de la collection pour le type de rapport spécifié, comme spécifié par le XxxReportByteLength membres de la structure HIDP_CAPS d’une collection.
Valeur de retour
HidP_InitializeReportForID retourne l’une des valeurs d’état suivantes :
Retourner le code | Description |
---|---|
|
Le rapport a été initialisé avec succès. |
|
Les données prédéfinies ne sont pas valides. |
|
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é. |
|
Le type de rapport n’est pas valide. |
|
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 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 la valeur zéro des 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.
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 |