fonction HidP_GetScaledUsageValue (hidpi.h)
La routine HidP_GetScaledUsageValue retourne le résultat signé et mis à l’échelle d’une valeur de contrôle HID extraite d’un rapport HID.
Syntaxe
NTSTATUS HidP_GetScaledUsageValue(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in] USHORT LinkCollection,
[in] USAGE Usage,
[out] PLONG UsageValue,
[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 identifie le type de rapport HID qui contient la valeur d’utilisation HID.
[in] UsagePage
Spécifie la page d’utilisation de la valeur à extraire.
[in] LinkCollection
Spécifie l’identificateur de collection de liens de la valeur à extraire. Une valeur LinkCollection de zéro identifie la collection de niveau supérieur.
[in] Usage
Spécifie l’utilisation de la valeur à extraire.
[out] UsageValue
Pointeur vers la mémoire tampon dans laquelle la routine retourne la valeur signée et mise à l’échelle.
[in] PreparsedData
Pointeur vers les données préparées de la collection de niveau supérieur qui a généré le rapport situé à rapport.
[in] Report
Pointeur vers le rapport qui contient l’utilisation.
[in] ReportLength
Spécifie la longueur, en octets, du rapport situé à Rapport.
Valeur de retour
HidP_GetScaledUsageValue retourne l’une des valeurs d’état suivantes :
| Retourner le code | Description |
|---|---|
| HIDP_STATUS_SUCCESS | La routine a correctement retourné la valeur. |
| HIDP_STATUS_INVALID_REPORT_TYPE | Le type de rapport spécifié n’est pas valide. |
| HIDP_STATUS_INVALID_REPORT_LENGTH | La longueur de rapport spécifiée n’est pas valide. |
| HIDP_STATUS_BAD_LOG_PHY_VALUES | La collection a retourné une valeur logique ou physique illégale. Pour extraire la valeur retournée par la collection, appelez HidP_GetUsageValue. |
| HIDP_STATUS_NULL | L’état actuel de la valeur mise à l’échelle de la collection est inférieur à la valeur minimale logique ou est supérieur à la valeur maximale logique, et la valeur mise à l’échelle a un état NULL. |
| HIDP_STATUS_VALUE_OUT_OF_RANGE | L’état actuel des données de valeur mise à l’échelle de la collection est inférieur au minimum logique ou est supérieur à la valeur maximale logique. |
| HIDP_STATUS_USAGE_NOT_FOUND | Impossible de trouver l’utilisation, la page d’utilisation ou la collection de liens spécifiées dans un rapport pris en charge par la collection de niveau supérieur spécifiée. |
| HIDP_STATUS_INCOMPATIBLE_REPORT_ID | La valeur spécifiée n’est pas contenue dans le rapport spécifié, mais elle est contenue dans un autre rapport pris en charge par la collection de niveau supérieur spécifiée. |
Remarques
Les valeurs mises à l’échelle font référence à la sortie ajustée des données HID brutes, qui sont modifiées en fonction de paramètres spécifiques tels que la sensibilité et la plage de l’appareil. Cet ajustement permet une interprétation plus significative des données par rapport à l’utilisation prévue de l’appareil.
Pour mieux comprendre comment les rapports HID sont interprétés et l’importance des valeurs mises à l’échelle, consultez 'interprétation des rapports HID.
Les mémoires tampons allouées par l’appelant fournies à PreparsedData, UsageValueet rapport doivent être allouées à partir du pool non paginé.
Les applications en mode utilisateur et les pilotes en mode noyau doivent utiliser HidP_GetUsageValueArray pour extraire des données pour un tableau de valeurs d’utilisation .
Si la routine retourne l’état HIDP_STATUS_BAD_LOG_PHY_VALUES, une application ou un pilote peut appeler HidP_GetUsageValue pour extraire les données d’utilisation brutes.
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 |