HidP_SetData-Funktion (hidpi.h)

Artikel
02/29/2024

Die HidP_SetData Routine legt einen angegebenen Satz von HID-Steuerelementschaltflächen und Wertverwendungen in einem HID-Bericht fest.

Syntax

NTSTATUS HidP_SetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in, out] PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [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 angibt, der sich unter Bericht befindet.

[in, out] DataList

Zeiger auf ein vom Aufrufer zugewiesenes Array von HIDP_DATA Strukturen, die angeben, welche Schaltflächen und Nutzungswerte festgelegt werden sollen.

[in, out] DataLength

Gibt bei der Eingabe die Anzahl der Member im DataList-Array an. Informationen zum Ausgabewert finden Sie im Abschnitt Hinweise.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer obersten Ebene.

[in] 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, den HidP_GetCaps in der HIDP_CAPS Struktur einer Sammlung zurückgibt.

Rückgabewert

HidP_SetData gibt HIDP_STATUS_SUCCESS zurück, wenn alle von DataList angegebenen Steuerelementdaten erfolgreich festgelegt wurden.

HidP_SetData gibt einen der folgenden status-Werte zurück, wenn einer der Eingabeparameter ungültig ist:

Rückgabecode	Beschreibung
HIDP_STATUS_INVALID_PREPARSED_DATA	Die von PreparsedData angegebenen vorbereiteten Daten sind ungültig.
HIDP_STATUS_INVALID_REPORT_LENGTH	Die Größe des HID-Berichts in Bytes entspricht nicht der Länge, die in der HIDP_CAPS Struktur der Auflistung für den angegebenen Berichtstyp angegeben ist.
HIDP_STATUS_INVALID_REPORT_TYPE	ReportType ist ungültig.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Die Auflistung enthält keinen Bericht des angegebenen Typs.

HidP_SetData gibt einen der folgenden Fehlerwerte zurück, wenn einer der angegebenen Schaltflächen- oder Verwendungswerte nicht festgelegt werden konnte:

Rückgabecode	Beschreibung
HIDP_STATUS_BUFFER_TOO_SMALL	Eine Schaltfläche in einem Array wurde nicht auf ON (1) festgelegt, da alle Arrayfelder bereits zum Indizieren anderer Schaltflächen verwendet werden.
HIDP_STATUS_BUTTON_NOT_PRESSED	Ein DataList-Element gibt an, dass eine Schaltfläche OFF (null) festgelegt wird, aber die Schaltfläche ist bereits auf OFF festgelegt.
HIDP_STATUS_DATA_INDEX_NOT_FOUND	Der Datenindex eines DataList-Elements ist ungültig.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Eine Schaltfläche oder ein Nutzungswert ist in einem Bericht enthalten, aber nicht im angegebenen Bericht.
HIDP_STATUS_IS_VALUE_ARRAY	Ein Datenindex gibt ein Verwendungswertarray an.

Hinweise

Mit Ausnahme von Verwendungswertarrays kann eine Benutzermodusanwendung oder ein Kernelmodustreiber HidP_SetData verwenden, um Schaltflächen und Nutzungswerte in einem Bericht festzulegen. Um ein Verwendungswertarray festzulegen, muss eine Anwendung oder ein Treiber HidP_SetUsageValueArray verwenden.

HidP_SetData legt den Ausgabewert von DataLength wie folgt fest:

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	PASSIVE_LEVEL