fonction HidP_UnsetUsages (hidpi.h)

Article
02/07/2025

Le HidP_UnsetUsages ensembles de routines spécifiés bouton de contrôle HID utilisations 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é à 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 n’est pas 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 de 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, 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 la des données préparées de la collection de niveau supérieur associée au rapport situé à rapport .

[in] Report

Pointeur vers un rapport.

[in] ReportLength

Spécifie la taille, en octets, du rapport 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_UnsetUsages retourne HIDP_STATUS_SUCCESS si elle définit correctement toutes les utilisations dans UsageList.

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

Retourner le code	Description
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données prédéfinies 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 d’état suivantes s’il n’a pas pu définir off l’une des utilisations de UsageList:

Retourner le code	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 elle est contenue dans un autre rapport du type spécifié.
HIDP_STATUS_USAGE_NOT_FOUND	La routine n’a pas trouvé d’utilisation dans un rapport du type spécifié.

Remarques

HidP_UnsetUsages définit UsageLength comme suit :

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

Voir aussi

Partager via