HidP_GetUsagesEx-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_GetUsagesEx Routine gibt eine Liste aller HID-Steuerelementschaltflächen Verwendungen zurück, die in einem HID-Bericht auf EIN festgelegt sind.

Syntax

NTSTATUS HidP_GetUsagesEx(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE_AND_PAGE      ButtonList,
  [in, out] ULONG                *UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumerationswert an, der den Berichtstyp identifiziert.

[in] LinkCollection

Gibt die Linkauflistung der Schaltflächenverwendungen an. Wenn LinkCollection- ungleich Null ist, gibt die Routine nur Informationen zu den Schaltflächen zurück, die diese Linkauflistung enthält; andernfalls, wenn LinkCollection null ist, gibt die Routine Informationen zu allen Schaltflächen in der Auflistung der obersten Ebene zugeordnet PreparsedData-zurück.

[in, out] ButtonList

Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der zum Zurückgeben der Verwendungs- und Verwendungsseite verwendet wird, Bezeichner für jede Schaltfläche, die auf EIN (1) festgelegt ist.

[in, out] UsageLength

Gibt für Eingaben die Länge des ButtonList- Puffers in Arrayelementen an. Gibt für die Ausgabe die Anzahl der Verwendungen an, die derzeit im angegebenen Bericht auf "EIN" festgelegt sind.

[in] PreparsedData

Zeiger auf die vordefinierten Daten einer Auflistung auf oberster Ebene.

[in] Report

Zeigen Sie auf einen Bericht, der Schaltflächendaten enthält.

[in] ReportLength

Gibt die Länge des Berichts in Bytes an, der sich in Reportbefindet.

Rückgabewert

HidP_GetUsagesEx gibt einen der folgenden Statuswerte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat erfolgreich alle Schaltflächenverwendungen zurückgegeben, die auf EIN festgelegt sind.
HIDP_INVALID_REPORT_LENGTH	Die Berichtslänge ist ungültig.
HIDP_INVALID_REPORT_TYPE	Der angegebene Berichtstyp ist ungültig.
HIDP_STATUS_BUFFER_TOO_SMALL	Der UsageList- Puffer ist zu klein, um alle verwendungen, die derzeit im angegebenen Bericht auf "EIN" festgelegt sind, zu halten.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Die Auflistung enthält Schaltflächen in einem Bericht des angegebenen Typs, aber im angegebenen Bericht gibt es keine derartigen Verwendungen.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die analysierten Daten sind ungültig.

Bemerkungen

Benutzermodusanwendungen und Kernelmodustreiber rufen HidP_MaxUsageListLength auf, um die maximale Anzahl von Schaltflächen zu bestimmen, die für den angegebenen Berichtstyp zurückgegeben werden. Alternativ können Anwendungen oder Treiber HidP_GetUsagesEx aufrufen und (*UsageLength) auf Null festlegen, um die erforderliche Länge in UsageLength-zurückzugeben. Mit anderen Worten, UsageLength- sollte ein gültiger Zeiger sein, der auf einen ULONG-Wert 0 zeigt, um die erforderliche Länge abzurufen.

Anwendungen oder Treiber bestimmen die erforderliche Berichtslänge aus der XxxReportByteLength Member in der HIDP_CAPS-Struktur einer Obersten Ebene.

Weitere Informationen finden Sie unter HID Collections.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar in Windows 2000 und höheren Versionen von Windows.
Zielplattform-	Universal
Header-	hidpi.h (include Hidpi.h)
Library	Hidparse.lib
IRQL-	<= DISPATCH_LEVEL