HidP_GetUsageValue-Funktion (hidpi.h)

Artikel
08/07/2023

Die HidP_GetUsageValue Routine extrahiert die Daten, die einem HID-Steuerelementwert zugeordnet sind, der den Auswahlkriterien in einem HID-Bericht entspricht.

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 Enumeratorwert an, der den Berichtstyp identifiziert.

[in] UsagePage

Gibt die Verwendungsseite des Werts an.

[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 der obersten Ebene , die PreparsedData zugeordnet ist.

[in] Usage

Gibt die Verwendung des Werts an.

[out] UsageValue

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

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer Sammlung auf oberster Ebene.

[in] Report

Zeiger auf einen Bericht, der Werte enthält.

[in] ReportLength

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

Rückgabewert

HidP_GetUsageValue gibt einen der folgenden status Werte 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 es gibt keine solchen Verwendungen im angegebenen Bericht.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die vorbereiteten 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.

Hinweise

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

HidP_GetUsageValue dient zum Extrahieren eines Nutzungswerts für eine Verwendung, deren Berichtsanzahl 1 ist. Wenn die angegebene Nutzung über eine Berichtsanzahl größer als 1 verfügt, ist die Nutzung Teil eines Nutzungswertarrays. 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-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