HidP_UnsetUsages, fonction (hidpi.h)

Article
08/07/2023

Le HidP_UnsetUsages de routine définit le bouton de contrôle HID spécifié inglément OFF (zéro) dans un rapport HID.

Syntaxe

NTSTATUS HidP_UnsetUsages(
  [in]           HIDP_REPORT_TYPE     ReportType,
  [in]           USAGE                UsagePage,
  [in, optional] 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 des utilisations spécifiées par UsageList.

[in, optional] 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, si elles existent, dans cette collection de liens. Si LinkCollection est égal à zéro, la routine définit la première utilisation pour chaque utilisation qu’elle trouve dans la collection de niveau supérieur associée à PreparsedData.

[in, out] UsageList

Pointeur vers le tableau d’utilisations à définir sur OFF.

[in, out] UsageLength

Spécifie, lors de l’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 de rapport pour le type de rapport spécifié que HidP_GetCaps retourne dans la structure HIDP_CAPS d’une collection.

Valeur retournée

HidP_UnsetUsages retourne HIDP_STATUS_SUCCESS s’il a correctement désactivé toutes les utilisations dans UsageList.

HidP_UnsetUsages retourne l’une des valeurs status suivantes si l’un des paramètres d’entrée n’est pas valide :

Code de retour	Description
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées spécifiées par PreparsedData ne sont pas valides.
HIDP_STATUS_INVALID_REPORT_LENGTH	La longueur du rapport n’est pas valide.
HIDP_STATUS_INVALID_REPORT_TYPE	Le type de rapport n’est pas valide.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	La collection ne contient pas de rapport du type spécifié.

HidP_UnsetUsages retourne l’une des valeurs status suivantes s’il n’a pas pu définir sur OFF l’une des utilisations dans UsageList :

Code de retour	Description
HIDP_STATUS_BUTTON_NOT_PRESSED	Une utilisation est déjà définie sur OFF.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Une utilisation n’est pas contenue dans le rapport spécifié, mais dans un autre rapport du type spécifié.
HIDP_STATUS_USAGE_NOT_FOUND	La routine n’a trouvé aucune utilisation dans un rapport du type spécifié.

Remarques

HidP_UnsetUsages définit UsageLength comme suit :

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

Voir aussi

Partager via