HidP_SetUsageValueArray-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_SetUsageValueArray Routine legt ein HID-Steuerelement Verwendungswertarray in einem angegebenen HID-Bericht fest.

Syntax

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

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumerationswert an, der den Typ des HID-Berichts angibt, der sich in Reportbefindet.

[in] UsagePage

Gibt die Verwendungsseite einer Verwendung an.

[in] LinkCollection

Gibt die Linkauflistung an, die die Verwendung enthält. Wenn LinkCollection- ungleich Null ist, legt die Routine nur die Verwendung fest, sofern vorhanden, in dieser Linkauflistung. Wenn LinkCollection- null ist, legt die Routine die erste Verwendung fest, die in der Auflistung der obersten Ebene zugeordnet PreparsedData-.

[in] Usage

Gibt die Verwendung an.

[in] UsageValue

Zeigen Sie auf einen vom Aufrufer zugewiesenen Puffer, der die Daten enthält, die dem Verwendungswertarray zugeordnet sind.

[in] UsageValueByteLength

Gibt die Länge des UsageValue- Puffers in Bytes an.

[in] PreparsedData

Zeiger auf die vordefinierten Daten auf oberster Ebene.

[in, out] Report

Zeiger auf einen HID-Bericht.

[in] ReportLength

Gibt die Größe des HID-Berichts in Bytes an, der sich in Reportbefindet, der der Berichtslänge für den angegebenen Berichtstyp entsprechen muss HidP_GetCaps, der in der HIDP_CAPS Struktur einer Auflistung zurückgegeben wird.

Rückgabewert

HidP_SetUsageValueArray gibt einen der folgenden Statuswerte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat den Verwendungswert erfolgreich festgelegt.
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	Die Größe des UsageValue- Puffers in Bytes ist zu klein.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Die Verwendung ist im angegebenen Bericht nicht vorhanden, ist aber in einem anderen Bericht des angegebenen Typs vorhanden.
HIDP_STATUS_NOT_VALUE_ARRAY	Die angegebene Verwendung ist kein Verwendungswertarray.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die analysierten Daten sind ungültig.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Es gibt keine Berichte des angegebenen Typs.
HIDP_STATUS_NOT_IMPLEMENTED	Die Berichtsgröße von Datenfeldern, die für das Verwendungswertarray angegeben sind, ist kein Vielfaches von acht Bits.
HIDP_STATUS_USAGE_NOT_FOUND	Die Verwendung ist in keinem Bericht des angegebenen Berichtstyps vorhanden.

Bemerkungen

Die erforderliche Größe des UsageValue Puffers wird durch Multiplizieren der BitSize und ReportCount Member der HIDP_VALUE_CAPS Struktur des Verwendungswertarrays bestimmt und das Ergebnis auf das nächste Byte aufgerundet.

HidP_SetUsageValueArray unterstützt nur Verwendungswertarrays, bei denen jedes Datenfeld des Arrays ein Vielfaches von acht Bits ist.

Der Aufrufer muss den UsageValue- Puffer genau so festlegen, wie er im Bericht auftreten sollte.

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

Siehe auch

HidP_SetScaledUsageValue

HidP_SetUsageValue

_HIDP_PREPARSED_DATA

Freigeben über