fonction HidP_SetUsageValue (hidpi.h)
La routine HidP_SetUsageValue définit une valeur de contrôle HID dans un rapport HID spécifié.
Syntaxe
NTSTATUS HidP_SetUsageValue(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in] USHORT LinkCollection,
[in] USAGE Usage,
[in] ULONG UsageValue,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in, out] 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é à rapport .
[in] UsagePage
Spécifie la page d’utilisation d’une utilisation.
[in] LinkCollection
Spécifie la collection de liens qui contient l’utilisation. Si LinkCollection n’est pas zéro, la routine définit uniquement l’utilisation, le cas échéant, dans cette collection de liens. Si LinkCollection est égal à zéro, la routine définit la première utilisation qu’elle trouve dans la collection de niveau supérieur associée à PreparsedData.
[in] Usage
Spécifie l’utilisation.
[in] UsageValue
Spécifie la valeur d’utilisation.
[in] PreparsedData
Pointeur vers le de données prédéfinies d’un niveau supérieur.
[in, out] Report
Pointeur vers un rapport HID.
[in] ReportLength
Spécifie la taille, en octets, du rapport HID situé à Rapport, qui doit être égale à la longueur du rapport pour le type de rapport spécifié qui HidP_GetCaps retourne dans la structure HIDP_CAPS d’une collection.
Valeur de retour
HidP_SetUsageValue retourne l’une des valeurs d’état suivantes :
Retourner le code | Description |
---|---|
|
La routine définit correctement la valeur d’utilisation. |
|
L’utilisation n’existe pas dans le rapport spécifié, mais elle existe dans un autre rapport du type spécifié. |
|
Les données prédéfinies ne sont pas valides. |
|
Il n’existe aucun rapport du type spécifié. |
|
L’utilisation n’existe pas dans un rapport du type de rapport spécifié. |
|
La longueur du rapport n’est pas valide. |
|
Le type de rapport spécifié n’est pas valide. |
Remarques
HidP_SetUsageValue routine ne signe pas la valeur. Une application en mode utilisateur ou un pilote en mode noyau doit signer la valeur, à la position fournie dans la structure HIDP_VALUE_CAPS pour cette valeur, ou appeler HidP_SetScaledUsageValue.
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 |