HidP_GetUsagesEx-Funktion (hidpi.h)

Artikel
08/07/2023

Die HidP_GetUsagesEx Routine gibt eine Liste aller Verwendungen der HID-Steuerelementschaltfläche zurück, die in einem HID-Bericht auf ON 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 Enumeratorwert 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 gibt die Routine, wenn LinkCollection null ist, Informationen zu allen Schaltflächen in der Auflistung der obersten Ebene zurück, die PreparsedData zugeordnet ist.

[in, out] ButtonList

Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der von der Routine verwendet wird, um die Nutzungs- und Nutzungsseitenbezeichner für jede Schaltfläche zurückzugeben, die auf ON (1) festgelegt ist.

[in, out] UsageLength

Gibt bei der Eingabe die Länge des ButtonList-Puffers in Arrayelementen an. Gibt bei der Ausgabe die Anzahl der Verwendungen an, die im angegebenen Bericht derzeit auf ON festgelegt sind.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer Sammlung auf oberster Ebene.

[in] Report

Zeiger auf einen Bericht, der Schaltflächendaten enthält.

[in] ReportLength

Gibt die Länge des Berichts in Byte an, der sich unter Bericht befindet.

Rückgabewert

HidP_GetUsagesEx gibt einen der folgenden status-Werte 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 zu speichern, die derzeit im angegebenen Bericht auf ON festgelegt sind.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Die Auflistung enthält Schaltflächen in einem Bericht des angegebenen Typs, aber es gibt keine solchen Verwendungen im angegebenen Bericht.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die vorbereiteten Daten sind ungültig.

Hinweise

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 0 festlegen, um die erforderliche Länge in UsageLength zurückzugeben. Anders ausgedrückt: UsageLength sollte ein gültiger Zeiger sein, der auf einen ULONG-Wert 0 zeigt, um die erforderliche Länge zu erhalten.

Anwendungen oder Treiber bestimmen die erforderliche Berichtslänge aus den XxxReportByteLength-Membern in der HIDP_CAPS-Struktur einer Sammlung der obersten Ebene.

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