HidP_GetSpecificButtonCaps-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_GetSpecificButtonCaps Routine gibt ein Schaltflächenfunktionsarray zurück, das alle HID-Steuerelementschaltflächen in einer Auflistung auf oberster Ebene beschreibt, die einem angegebenen Auswahlkriterium entsprechen.

Syntax

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [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.

[in] UsagePage

Gibt eine Verwendungsseite als Suchkriterien an. Wenn UsagePage- ungleich Null ist, werden nur Schaltflächen zurückgegeben, die diese Verwendungsseite angeben.

[in] LinkCollection

Gibt eine Linkauflistung als Suchkriterien an. Wenn LinkCollection- ungleich Null ist, werden nur Schaltflächen zurückgegeben, die Teil dieser Linksammlung sind.

[in] Usage

Gibt eine HID-Verwendung als Suchkriterien an. Wenn Usage ungleich Null ist, werden nur Schaltflächen zurückgegeben, die diese Verwendung angeben.

[out] ButtonCaps

Zeiger auf einen vom Aufrufer zugewiesenen Puffer, in dem die Routine ein Schaltflächenfunktionsarray für den angegebenen Berichtstyp zurückgibt.

[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 Anzahl der Elemente festgelegt, die die Routine tatsächlich zurückgegeben hat.

[in] PreparsedData

Zeigen Sie auf die vordefinierten DateneinerAuflistung auf oberster Ebene.

Rückgabewert

HidP_GetSpecificButtonCaps 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

Die erforderliche Größe des ButtonCaps Arrays wird durch die NumberXxxButtonCaps Member der HIDP_CAPS-Struktur einer Auflistung auf oberster Ebene angegeben.

Beim Aufrufen von HidP_GetSpecificButtonCapsentspricht das Angeben von Null für UsagePage, Usageund LinkCollection- dem Aufrufen von HidP_GetButtonCaps.

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

Freigeben über