HidP_GetUsageValue-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_GetUsageValue Routine extrahiert die Mit einem HID-Steuerelementwert verknüpften Daten, die den Auswahlkriterien in einem HID-Bericht entsprechen.

Syntax

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [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] UsagePage

Gibt die Verwendungsseite des Wertsan.

[in] LinkCollection

Gibt die Linkauflistung an, die den Wert enthält. Wenn LinkCollection- ungleich Null ist, sucht die Routine nur nach der Verwendung in dieser Linksammlung; andernfalls sucht die Routine, wenn LinkCollection- null ist, nach der Verwendung in der Auflistung auf oberster Ebene zugeordnet PreparsedData.

[in] Usage

Gibt die Verwendung des Werts an.

[out] UsageValue

Zeigen Sie auf einen Puffer, in dem die Routine die Wertdaten zurückgibt.

[in] PreparsedData

Zeiger auf die vordefinierten Daten einer Auflistung auf oberster Ebene.

[in] Report

Zeigen Sie auf einen Bericht, der Werte enthält.

[in] ReportLength

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

Rückgabewert

HidP_GetUsageValue gibt einen der folgenden Statuswerte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat die Wertdaten erfolgreich zurückgegeben.
HIDP_INVALID_REPORT_LENGTH	Die Berichtslänge ist ungültig.
HIDP_INVALID_REPORT_TYPE	Der angegebene Berichtstyp ist ungültig.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Die Auflistung enthält einen Wert 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 keinen Wert auf der angegebenen Verwendungsseite in einem Bericht des angegebenen Berichtstyps.

Bemerkungen

HidP_GetUsageValue signiert oder skaliert den Wert nicht. Um einen signierten Wert zu extrahieren, verwenden Sie HidP_GetScaledUsageValue. Um das Zeichenbit manuell zuzuweisen, kann die Position des Zeichenbits anhand der Informationen in der HIDP_VALUE_CAPS Struktur eines Werts bestimmt werden.

HidP_GetUsageValue dient zum Extrahieren eines Verwendungswerts für eine Verwendung, deren Berichtsanzahl 1 ist. Wenn die angegebene Verwendung eine Berichtsanzahl größer als 1 hat, ist die Verwendung Teil eines Verwendungswertarrays. HidP_GetUsageValue gibt nur das erste Datenelement in einem Verwendungswertarray zurück. Verwenden Sie HidP_GetUsageValueArray, um alle Datenelemente in einem Verwendungswertarray zu extrahieren.

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