HidP_UnsetUsages-Funktion (hidpi.h)

Artikel
02/26/2024

Die HidP_UnsetUsages Routine legt die angegebenen VERWENDUNGen der HID-Steuerungsschaltfläche in einem HID-Bericht OFF (Null) fest.

Syntax

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
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Typ des Berichts angibt, der sich unter Bericht befindet.

[in] UsagePage

Gibt die Verwendungsseite der von UsageList angegebenen Verwendungen an.

[in, optional] LinkCollection

Gibt die Linkauflistung an, die die Verwendungen enthält. Wenn LinkCollection ungleich null ist, legt die Routine nur die Verwendungen in dieser Linkauflistung fest, sofern vorhanden. Wenn LinkCollection null ist, legt die Routine die erste Verwendung für jede Verwendung fest, die sie in der Auflistung der obersten Ebene findet, die PreparsedData zugeordnet ist.

[in, out] UsageList

Zeiger auf das Array von Verwendungen, das auf OFF festgelegt werden soll.

[in, out] UsageLength

Gibt bei der Eingabe die Anzahl der Verwendungen in UsageList an. Informationen zum Ausgabewert finden Sie im Abschnitt Hinweise.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten der Auflistung der obersten Ebene, die dem Bericht unter Bericht zugeordnet ist.

[in] Report

Zeiger auf einen Bericht.

[in] ReportLength

Gibt die Größe des Berichts in Byte an, der sich unter Bericht befindet, die der Berichtslänge für den angegebenen Berichtstyp entsprechen muss, der HidP_GetCaps in der HIDP_CAPS-Struktur einer Auflistung zurückgibt.

Rückgabewert

HidP_UnsetUsages gibt HIDP_STATUS_SUCCESS zurück, wenn alle Verwendungen in UsageList erfolgreich auf OFF festgelegt sind.

HidP_UnsetUsages gibt einen der folgenden status Werte zurück, wenn einer der Eingabeparameter ungültig ist:

Rückgabecode	Beschreibung
HIDP_STATUS_INVALID_PREPARSED_DATA	Die von PreparsedData angegebenen vorbereiteten Daten sind ungültig.
HIDP_STATUS_INVALID_REPORT_LENGTH	Die Berichtslänge ist ungültig.
HIDP_STATUS_INVALID_REPORT_TYPE	Der Berichtstyp ist ungültig.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Die Auflistung enthält keinen Bericht des angegebenen Typs.

HidP_UnsetUsages gibt einen der folgenden status-Werte zurück, wenn eine der Verwendungen in UsageList nicht auf OFF festgelegt werden konnte:

Rückgabecode	Beschreibung
HIDP_STATUS_BUTTON_NOT_PRESSED	Eine Verwendung ist bereits auf OFF festgelegt.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Eine Verwendung ist nicht im angegebenen Bericht enthalten, sondern in einem anderen Bericht des angegebenen Typs enthalten.
HIDP_STATUS_USAGE_NOT_FOUND	Die Routine hat in keinem Bericht des angegebenen Typs eine Verwendung gefunden.

Hinweise

HidP_UnsetUsages legt UsageLength wie folgt fest:

Weitere Informationen finden Sie unter HID-Auflistungen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows 2000 und höheren Versionen von Windows.
Zielplattform	Universell
Header	hidpi.h (hidpi.h einschließen)
Bibliothek	Hidparse.lib
IRQL	<=DISPATCH_LEVEL

Weitere Informationen

Freigeben über