HidP_GetScaledUsageValue-Funktion (hidpi.h)

Artikel
02/26/2024

Die HidP_GetScaledUsageValue Routine gibt das signierte und skalierte Ergebnis eines HID-Steuerelementwerts zurück, der aus einem HID-Bericht extrahiert wurde.

Syntax

NTSTATUS HidP_GetScaledUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PLONG                UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Typ des HID-Berichts identifiziert, der den HID-Nutzungswert enthält.

[in] UsagePage

Gibt die Verwendungsseite des zu extrahierenden Werts an.

[in] LinkCollection

Gibt den Linksammlungsbezeichner des zu extrahierenden Werts an. Ein LinkCollection-Wert von 0 identifiziert die Auflistung der obersten Ebene.

[in] Usage

Gibt die Verwendung des zu extrahierenden Werts an.

[out] UsageValue

Zeiger auf den Puffer, in dem die Routine den signierten und skalierten Wert zurückgibt.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten der Sammlung der obersten Ebene , die den Bericht unter Bericht generiert hat.

[in] Report

Zeiger auf den Bericht, der die Verwendung enthält.

[in] ReportLength

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

Rückgabewert

HidP_GetScaledUsageValue gibt einen der folgenden status Werte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat den Wert erfolgreich zurückgegeben.
HIDP_STATUS_INVALID_REPORT_TYPE	Der angegebene Berichtstyp ist ungültig.
HIDP_STATUS_INVALID_REPORT_LENGTH	Die angegebene Berichtslänge ist ungültig.
HIDP_STATUS_BAD_LOG_PHY_VALUES	Die Auflistung hat einen ungültigen logischen oder physischen Wert zurückgegeben. Um den von der Auflistung zurückgegebenen Wert zu extrahieren, rufen Sie HidP_GetUsageValue auf.
HIDP_STATUS_NULL	Der aktuelle Zustand des skalierten Werts aus der Auflistung ist kleiner als das logische Minimum oder ist größer als das logische Maximum, und der skalierte Wert hat den NULL-Zustand .
HIDP_STATUS_VALUE_OUT_OF_RANGE	Der aktuelle Zustand der skalierten Wertdaten aus der Auflistung ist kleiner als das logische Minimum oder größer als das logische Maximum.
HIDP_STATUS_USAGE_NOT_FOUND	Die angegebene Verwendungs-, Verwendungsseite oder Linksammlung kann in keinem Bericht gefunden werden, der von der angegebenen Auflistung der obersten Ebene unterstützt wird.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Der angegebene Wert ist nicht im angegebenen Bericht enthalten, sondern in einem anderen Bericht enthalten, der von der angegebenen Auflistung der obersten Ebene unterstützt wird.

Hinweise

Die vom Aufrufer zugewiesenen Puffer, die unter PreparsedData, UsageValue und Report bereitgestellt werden, müssen aus einem nicht ausgestellten Pool zugewiesen werden.

Benutzermodusanwendungen und Kernelmodustreiber müssen HidP_GetUsageValueArray verwenden, um Daten für ein Nutzungswertarray zu extrahieren.

Wenn die Routine status HIDP_STATUS_BAD_LOG_PHY_VALUES zurückgibt, kann eine Anwendung oder ein Treiber HidP_GetUsageValue aufrufen, um die rohen Nutzungsdaten zu extrahieren.

Weitere Informationen finden Sie unter HID-Sammlungen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows 2000 und höheren Versionen von Windows.
Zielplattform	Universell
Header	hidpi.h (einschließlich Hidpi.h)
Bibliothek	Hidparse.lib
IRQL	<= DISPATCH_LEVEL

Weitere Informationen

HidP_GetUsageValue

HidP_GetUsageValueArray

_HIDP_PREPARSED_DATA

Freigeben über