HidP_SetButtonArray-Funktion (hidpi.h)

  • Artikel

Die HidP_SetButtonArray-Funktion legt den Zustand von Schaltflächen über ein Array von HIDP_BUTTON_ARRAY_DATA Strukturen fest.

Syntax

NTSTATUS HidP_SetButtonArray(
  HIDP_REPORT_TYPE        ReportType,
  USAGE                   UsagePage,
  USHORT                  LinkCollection,
  USAGE                   Usage,
  PHIDP_BUTTON_ARRAY_DATA ButtonData,
  USHORT                  ButtonDataLength,
  PHIDP_PREPARSED_DATA    PreparsedData,
  PCHAR                   Report,
  ULONG                   ReportLength
);

Parameter

ReportType

Ein Wert von HidP_Output oder HidP_Feature aus der HIDP_REPORT_TYPE-Enumeration .

UsagePage

Die Verwendungsseite, auf die sich die angegebene Verwendung bezieht.

LinkCollection

(Optional) Dieser Wert kann verwendet werden, um zwischen zwei Feldern zu unterscheiden, die möglicherweise die gleiche UsagePage und Usage aufweisen, aber in unterschiedlichen Sammlungen vorhanden sind. Wenn der Wert HIDP_LINK_COLLECTION_UNSPECIFIED ist, wird das erste gefundene Schaltflächenarray zurückgegeben, das mit usagePage und Usage übereinstimmt, unabhängig vom Speicherort. Wenn der Wert HIDP_LINK_COLLECTION_ROOT ist, wird das erste gefundene Schaltflächenarray in der Stammauflistung zurückgegeben, das den UsagePage - und Usage-Werten entspricht.

Usage

Die Verwendung, deren Schaltflächenarray HidP_SetButtonArray festgelegt wird.

ButtonData

Der Puffer mit den Werten, die im Schaltflächenarray festgelegt werden sollen.

ButtonDataLength

Anzahl der Elemente im ButtonData-Puffer .

PreparsedData

Die analysierten Daten, die von HIDCLASS zurückgegeben werden.

Report

Das Berichtspaket. Das erste Byte muss die ReportId sein.

ReportLength

Länge des angegebenen Berichtspakets in Bytes.

Rückgabewert

HidP_SetButtonArray gibt einen der folgenden status Werte zurück:

Rückgabecode Beschreibung
HIDP_STATUS_SUCCESS Das Schaltflächenarray im Berichtspaket wurde erfolgreich festgelegt.
HIDP_STATUS_INVALID_REPORT_TYPE ReportType ist ungültig.
HIDP_STATUS_INVALID_PREPARSED_DATA PreparsedData ist ungültig
HIDP_STATUS_INVALID_REPORT_LENGTH Die Länge des Berichtspakets entspricht nicht der Länge, die in der HIDP_CAPS-Struktur für den angegebenen ReportType angegeben ist.
HIDP_STATUS_REPORT_DOES_NOT_EXIST Es gibt keine Berichte auf diesem Gerät für den angegebenen ReportType.
HIDP_STATUS_NOT_BUTTON_ARRAY Das angegebene Steuerelement ist kein Schaltflächenarray.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID Die angegebene Nutzungsseite, Die angegebene Verwendungs- und Linksammlung ist in einem Bericht mit einer anderen Berichts-ID als der übergebene Bericht vorhanden.
HIDP_STATUS_USAGE_NOT_FOUND Die Kombination aus Nutzungsseite, Verwendung und Linksammlung ist in keinem Bericht für diesen ReportType vorhanden.
HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE Der ArrayIndex für eine der angegebenen HIDP_BUTTON_ARRAY_DATA Strukturen befindet sich außerhalb des gültigen Bereichs für dieses Schaltflächenarray.

Hinweise

HidP_SetButtonArray legt den Status der Schaltflächen für das erste Schaltflächenarray fest, das innerhalb der angegebenen LinkCollection gefunden wurde, mit der angegebenen Verwendung für den angegebenen Bericht.

Der Aufrufer sollte HidP_GetVersion verwenden, um zu bestimmen, ob diese Funktion verfügbar ist. HidP_SetButtonArray ist nur verfügbar, wenn HidP_GetVersion einen Wert von mindestens zwei zurückgibt. Version 2 der API entspricht Windows 11.

Ein Schaltflächenarray tritt auf, wenn die letzte Verwendung in der Reihenfolge der Verwendungen, die ein Standard Element beschreiben, wiederholt werden muss, da weniger Verwendungen als der für das angegebene Standard Element deklarierte ReportCount definiert sind. In diesem Fall wird ein einzelner HIDP_BUTTON_CAPS für diese Verwendung zugewiesen, und der ReportCount des HIDP_BUTTON_CAPS wird so festgelegt, dass die Anzahl der Felder, auf die die Verwendung verweist, widerspiegelt.

Bei einer HIDP_BUTTON_CAPS , die ein Schaltflächenarray beschreibt, ist ReportCount immer größer als eins. Wenn ReportCount gleich eins ist, handelt es sich nicht um ein Schaltflächenarray und kann nicht mit HidP_SetButtonArray verwendet werden. Weitere Informationen finden Sie unter HidP_SetUsages.

Anforderungen

Anforderung Wert
Header hidpi.h

Weitere Informationen