HidP_GetSpecificButtonCaps-Funktion (hidpi.h)

Artikel
02/29/2024

Die HidP_GetSpecificButtonCaps Routine gibt ein Schaltflächenfunktionsarray zurück, das alle HID-Steuerelementschaltflächen in einer Auflistung der obersten 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 Enumeratorwert an, der den Berichtstyp identifiziert.

[in] UsagePage

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

[in] LinkCollection

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

[in] Usage

Gibt eine HID-Verwendung als Suchkriterium an. Wenn Nutzung 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 unter ButtonCaps bereitgestellt wird. Bei der Ausgabe wird dieser Parameter auf die Anzahl der Elemente festgelegt, die die Routine tatsächlich zurückgegeben hat.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer Sammlung auf oberster Ebene.

Rückgabewert

HidP_GetSpecificButtonCaps gibt einen der folgenden status Werte zurück:

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

Hinweise

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

Beim Aufrufen HidP_GetSpecificButtonCaps entspricht die Angabe von null für UsagePage, Usage und LinkCollection dem Aufrufen HidP_GetButtonCaps.

Weitere Informationen zu den Funktionen einer Sammlung finden Sie unter Abrufen von Sammlungsinformationen.

Siehe auch 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 (hidpi.h einschließen)
Bibliothek	Hidparse.lib
IRQL	PASSIVE_LEVEL

Weitere Informationen