HidP_GetButtonCaps-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_GetButtonCaps Routine gibt ein Schaltflächenfunktionsarray zurück, das alle HID-Steuerelementschaltflächen in einer Auflistung auf oberster Ebene für einen bestimmten HID-Berichttyp beschreibt.

Syntax

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumerationswert an, der den Berichtstyp identifiziert.

[out] ButtonCaps

Zeigen Sie auf einen vom Aufrufer zugewiesenen Puffer, den die Routine zum Zurückgeben eines Schaltflächenfunktionsarrays für den angegebenen Berichtstyp verwendet.

[in, out] ButtonCapsLength

Gibt die Länge für die Eingabe in Arrayelementen des Puffers an, der bei ButtonCapsbereitgestellt wird. Bei der Ausgabe wird dieser Parameter auf die tatsächliche Anzahl der Elemente festgelegt, die von der Routine zurückgegeben werden.

[in] PreparsedData

Zeiger auf die vordefinierten Daten einer Auflistung auf oberster Ebene.

Rückgabewert

HidP_GetButtonCaps gibt einen der folgenden Statuswerte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat die Funktionsdaten erfolgreich zurückgegeben.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die analysierten Daten sind ungültig.

Bemerkungen

HidP_GetButtonCaps gibt die Funktion aller Schaltflächen in einer Auflistung der obersten Ebene für einen angegebenen Berichtstyp zurück.

ButtonCapsLength- sollte auf den Wert der NumberXxxButtonCaps Member der HIDP_CAPS Struktur festgelegt werden, die von HidP_GetCapszurückgegeben wird, wobei Xxx- den Berichtstyp angibt.

Um eine Teilmenge der Schaltflächenfunktionen abzurufen, die durch Verwendung, Verwendungsseiteoder Linksammlungausgewählt werden, verwenden Sie HidP_GetSpecificButtonCaps.

Weitere Informationen zur Funktion einer Sammlung finden Sie unter Abrufen von Sammlungsinformationen.

Siehe auch 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

Siehe auch

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA

Freigeben über