HidP_GetValueCaps-Funktion (hidpi.h)

Artikel
02/29/2024

Die HidP_GetValueCaps Routine gibt ein Wertfunktionsarray zurück, das alle HID-Steuerelementwerte in einer Auflistung der obersten Ebene für einen angegebenen Typ von HID-Bericht beschreibt.

Syntax

NTSTATUS HidP_GetValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Berichtstyp identifiziert.

[out] ValueCaps

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

[in, out] ValueCapsLength

Gibt die Länge des ValueCaps-Puffers bei der Eingabe in Arrayelementen an. Bei der Ausgabe legt die Routine ValueCapsLength auf die Anzahl der Elemente fest, die tatsächlich zurückgegeben werden.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer Sammlung auf oberster Ebene.

Rückgabewert

HidP_GetValueCaps 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 richtige Länge für ValueCapsLength wird durch die NumberXxxValueCaps-Member der HIDP_CAPS-Struktur einer Auflistung der obersten Ebene angegeben.

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	<= DISPATCH_LEVEL