fonction HidP_SetScaledUsageValue (hidpi.h)

Article
02/29/2024

La routine HidP_SetScaledUsageValue convertit un nombre physique signé et mis à l’échelle en valeur logique d’une utilisation HID et définit la valeur d’utilisation dans un rapport HID spécifié.

Syntaxe

NTSTATUS HidP_SetScaledUsageValue(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [in]      LONG                 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é dans 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 est différent de 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 le nombre physique signé et mis à l’échelle, que la routine convertit en valeur logique de l’utilisation.

[in] PreparsedData

Pointeur vers les données préparées 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é dans Rapport, qui doit être égale à la longueur du rapport pour le type de rapport spécifié que HidP_GetCaps retourne dans la structure HIDP_CAPS d’une collection.

Valeur retournée

HidP_SetScaledUsageValue retourne l’une des valeurs status suivantes :

Code de retour	Description
HIDP_STATUS_SUCCESS	La routine a correctement défini la valeur d’utilisation.
HIDP_STATUS_BAD_LOG_PHY_VALUES	L’utilisation a une plage logique ou physique non valide qui empêche la mise à l’échelle.
HIDP_STATUS_VALUE_OUT_OF_RANGE	La valeur physique spécifiée est hors plage et l’utilisation n’a pas de valeur Null.
HIDP_STATUS_INVALID_REPORT_LENGTH	La longueur du rapport n’est pas valide.
HIDP_STATUS_INVALID_REPORT_TYPE	Le type de rapport spécifié n’est pas valide.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	L’utilisation n’existe pas dans le rapport spécifié, mais elle existe dans un autre rapport du type spécifié.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées ne sont pas valides.
HIDP_STATUS_USAGE_NOT_FOUND	L’utilisation n’existe dans aucun rapport du type de rapport spécifié.
HIDP_STATUS_NULL	La valeur physique spécifiée est hors plage, l’utilisation a une valeur null et la routine définit la valeur null.

Remarques

HidP_SetScaledUsageValue définit le bit de signe.

Si la routine retourne HIDP_STATUS_INCOMPATIBLE_REPORT_ID, le rapport spécifié contient l’utilisation. Toutefois, une application en mode utilisateur ou un pilote en mode noyau peut définir l’utilisation dans un rapport initialisé zéro. Consultez Initialisation des rapports HID.

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