HidP_SetUsageValue-Funktion (hidpi.h)

Die HidP_SetUsageValue Routine legt einen HID-Steuerelementwert in einem angegebenen HID-Bericht fest.

Syntax

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

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Typ des HID-Berichts angibt, der sich unter Bericht befindet.

[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 in dieser Linkauflistung fest, sofern vorhanden. Wenn LinkCollection null ist, legt die Routine die erste Verwendung fest, die sie in der Auflistung der obersten Ebene findet, die PreparsedData zugeordnet ist.

[in] Usage

Gibt die Verwendung an.

[in] UsageValue

Gibt den Verwendungswert an.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer obersten Ebene.

[in, out] Report

Zeiger auf einen HID-Bericht.

[in] ReportLength

Gibt die Größe des HID-Berichts in Byte an, der sich unter Bericht befindet, die der Berichtslänge für den angegebenen Berichtstyp entsprechen muss, der HidP_GetCaps in der HIDP_CAPS-Struktur einer Auflistung zurückgibt.

Rückgabewert

HidP_SetUsageValue gibt einen der folgenden status Werte zurück:

Rückgabecode Beschreibung
HIDP_STATUS_SUCCESS
Die Routine hat den Nutzungswert erfolgreich festgelegt.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID
Die Verwendung ist im angegebenen Bericht nicht vorhanden, aber sie ist in einem anderen Bericht des angegebenen Typs vorhanden.
HIDP_STATUS_INVALID_PREPARSED_DATA
Die vorbereiteten Daten sind ungültig.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
Es gibt keine Berichte des angegebenen Typs.
HIDP_STATUS_USAGE_NOT_FOUND
Die Verwendung ist in keinem Bericht des angegebenen Berichtstyps vorhanden.
HIDP_STATUS_INVALID_REPORT_LENGTH
Die Berichtslänge ist ungültig.
HIDP_STATUS_INVALID_REPORT_TYPE
Der angegebene Berichtstyp ist ungültig.

Hinweise

HidP_SetUsageValue Routine signiert den Wert nicht. Eine Benutzermodusanwendung oder ein Kernelmodustreiber muss entweder den Wert an der Position signieren, die in der HIDP_VALUE_CAPS-Struktur für diesen Wert angegeben ist, oder HidP_SetScaledUsageValue aufrufen.

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

Weitere Informationen

HIDP_VALUE_CAPS

HidP_SetScaledUsageValue

_HIDP_PREPARSED_DATA