fonction HidP_SetUsages (hidpi.h)

Article
03/05/2024

Le HidP_SetUsages routine définit les boutons de contrôle HID spécifiés ON (1) dans un rapport HID.

Syntaxe

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [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 indique le type de rapport situé dans Rapport.

[in] UsagePage

Spécifie la page d’utilisation pour les utilisations spécifiées par UsageList.

[in] LinkCollection

Spécifie la collection de liens qui contient les utilisations. Si LinkCollection est différent de zéro, la routine définit uniquement les utilisations, le cas échéant, dans cette collection de liens. Si LinkCollection est égal à zéro, la routine définit la première utilisation pour chaque utilisation spécifiée dans la collection de niveau supérieur associée à PreparsedData.

[in, out] UsageList

Pointeur vers le tableau d’utilisations.

[in, out] UsageLength

Spécifie, en entrée, le nombre d’utilisations dans UsageList. Pour plus d’informations sur la valeur de sortie, consultez la section Remarques.

[in] PreparsedData

Pointeur vers les données préparées de la collection de niveau supérieur associée au rapport situé dans Rapport.

[in] Report

Pointeur vers un rapport.

[in] ReportLength

Spécifie la taille, en octets, du rapport 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_SetUsages 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_BUFFER_TOO_SMALL	Une utilisation dans un tableau de boutons ne peut pas être définie, car le tableau est déjà entièrement défini.
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	Une 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	Une utilisation n’existe dans aucun rapport du type de rapport spécifié.

Remarques

Si HidP_SetUsages ne peut pas définir une utilisation dans UsageList, la routine définit UsageLength sur l’index de l’utilisation qui n’a pas pu être définie et retourne une valeur status qui indique l’erreur.

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