Freigeben über

HidP_GetUsages-Funktion (hidpi.h)

Die HidP_GetUsages Routine gibt eine Liste aller HID-Steuerelementschaltflächennutzungen zurück, die sich auf einer angegebenen Verwendungsseite befinden und in einem HID-Bericht auf "EIN" festgelegt sind.

Syntax

NTSTATUS HidP_GetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [out]     PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [out]     PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumerationswert an, der den Berichtstyp identifiziert.

[in] UsagePage

Gibt die Verwendungsseite der Schaltflächenverwendungen an. Die Routine gibt nur Informationen zu Schaltflächen auf dieser Verwendungsseite zurück.

[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.

[out] UsageList

Zeigen Sie auf einen vom Aufrufer zugewiesenen Puffer, den die Routine verwendet, um die Verwendung aller Schaltflächen zurückzugeben, die auf EIN festgelegt sind, und gehören zu der durch UsagePageangegebenen Verwendungsseite.

[in, out] UsageLength

Gibt für Eingaben die Länge des UsageList- Puffers in Arrayelementen an. Gibt bei der Ausgabe die Anzahl der Schaltflächen an, die auf "EIN" auf der angegebenen Verwendungsseite festgelegt sind.

[in] PreparsedData

Zeiger auf die vordefinierten Daten einer Auflistung auf oberster Ebene.

[out] Report

Zeiger auf einen Bericht.

[in] ReportLength

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

Rückgabewert

HidP_GetUsages 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_STATUS_INVALID_REPORT_LENGTH Die Berichtslänge ist ungültig.
HIDP_STATUS_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 auf "EIN" auf der angegebenen Verwendungsseite festgelegt sind, zu speichern.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID Die Auflistung enthält Schaltflächen auf der angegebenen Verwendungsseite 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.
HIDP_STATUS_USAGE_NOT_FOUND Die Auflistung enthält keine Schaltflächen auf der angegebenen Verwendungsseite in einem Bericht des angegebenen Berichtstyps.

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 können. Alternativ können Anwendungen oder Treiber HidP_GetUsages 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- universell
Header- hidpi.h (include Hidpi.h)
Bibliothek Hidparse.lib
IRQL- <= DISPATCH_LEVEL

Siehe auch