HidP_GetButtonCaps-Funktion (hidpi.h)
Die HidP_GetButtonCaps Routine gibt ein Schaltflächenfunktionsarray zurück, das alle HID-Steuerelementschaltflächen in einer Auflistung der obersten Ebene für einen angegebenen Typ von HID-Bericht 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 Enumeratorwert an, der den Berichtstyp identifiziert.
[out] ButtonCaps
Zeiger auf einen vom Aufrufer zugewiesenen Puffer, den die Routine verwendet, um ein Schaltflächenfunktionsarray für den angegebenen Berichtstyp zurückzugeben.
[in, out] ButtonCapsLength
Gibt die Länge des in ButtonCaps bereitgestellten Puffers für eingaben in Arrayelementen an. Bei der Ausgabe wird dieser Parameter auf die tatsächliche Anzahl von Elementen festgelegt, die die Routine zurückgibt.
[in] PreparsedData
Zeiger auf die vorbereiteten Daten einer Sammlung auf oberster Ebene.
Rückgabewert
HidP_GetButtonCaps gibt einen der folgenden status Werte zurück:
| Rückgabecode | Beschreibung |
|---|---|
|
Die Routine hat die Funktionsdaten erfolgreich zurückgegeben. |
|
Die vorbereiteten Daten sind ungültig. |
Hinweise
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 des NumberXxxButtonCaps-Members der von HidP_GetCaps zurückgegebenen HIDP_CAPS-Struktur festgelegt werden, wobei Xxx den Berichtstyp angibt.
Verwenden Sie HidP_GetSpecificButtonCaps, um eine Teilmenge der Schaltflächenfunktionen abzurufen, die nach Verwendung, Verwendungsseite oder Linksammlung ausgewählt werden.
Weitere Informationen zur Funktion 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 (einschließlich Hidpi.h) |
| Bibliothek | Hidparse.lib |
| IRQL | PASSIVE_LEVEL |