HidP_SetData-Funktion (hidpi.h)

Artikel
02/07/2025

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 Enumerationswert an, der den Typ des HID-Berichts angibt, der sich in Reportbefindet.

[in, out] DataList

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

[in, out] DataLength

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

[in] PreparsedData

Zeiger auf die vordefinierten Daten auf oberster Ebene.

[in] 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_SetData gibt HIDP_STATUS_SUCCESS zurück, wenn alle durch DataList-angegebenen Steuerelementdaten erfolgreich festgelegt werden.

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

Rückgabecode	Beschreibung
HIDP_STATUS_INVALID_PREPARSED_DATA	Die durch PreparsedData- angegebenen vordefinierten 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- ungültig ist.
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 eine 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 EIN (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 AUS (Null) festgelegt wird, die Schaltfläche jedoch bereits auf OFF festgelegt ist.
HIDP_STATUS_DATA_INDEX_NOT_FOUND	Der Datenindex eines DataList-Elements ist ungültig.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Eine Schaltfläche oder ein Verwendungswert ist in einem Bericht enthalten, aber nicht im angegebenen Bericht.
HIDP_STATUS_IS_VALUE_ARRAY	Ein Datenindex gibt ein Verwendungswertarrayan.

Bemerkungen

Mit Ausnahme von Verwendungswertarrays kann ein Benutzermodusanwendungs- oder Kernelmodustreiber HidP_SetData verwenden, um Schaltflächen und Verwendungswerte in einem Bericht festzulegen. Um ein Verwendungswertarray festzulegen, muss eine Anwendung oder ein Treiber HidP_SetUsageValueArrayverwenden.

HidP_SetData legt den Ausgabewert DataLength- wie folgt fest:

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-	PASSIVE_LEVEL