HidP_GetData-Funktion (hidpi.h)
Die HidP_GetData Routine gibt für einen angegebenen Bericht ein Array von HIDP_DATA Strukturen zurück, die die Datenindizes aller HID-Steuerelementschaltflächen identifizieren, die derzeit auf ON (1) festgelegt sind, sowie die Datenindizes und Daten, die allen HID-Steuerelementwerten zugeordnet sind.
Syntax
NTSTATUS HidP_GetData(
[in] HIDP_REPORT_TYPE ReportType,
[out] PHIDP_DATA DataList,
[in, out] PULONG DataLength,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in] PCHAR Report,
[in] ULONG ReportLength
);
Parameter
[in] ReportType
Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Typ des HID-Berichts angibt, der sich unter Bericht befindet.
[out] DataList
Gibt ein vom Aufrufer zugewiesenes Array von HIDP_DATA Strukturen an, die die Routine verwendet, um Informationen zu allen Schaltflächen zurückzugeben, die derzeit auf ON festgelegt sind, und die Daten, die Werten zugeordnet sind.
[in, out] DataLength
Gibt bei der Eingabe die Anzahl der Strukturen an, die das vom Aufrufer zugewiesene DataList-Array enthält. Gibt bei der Ausgabe die Anzahl der Steuerelemente an, für die die Routine Daten zurückgeben kann, einschließlich aller Schaltflächen, die derzeit auf ON festgelegt sind, und alle Steuerelementwerte.
[in] PreparsedData
Zeiger auf die vorbereiteten Daten der Sammlung der obersten Ebene, die dem HID-Bericht unter Bericht zugeordnet ist.
[in] Report
Zeiger auf einen HID-Bericht.
[in] ReportLength
Gibt die Größe des HID-Berichts in Bytes an, der sich unter Bericht befindet, die der Berichtslänge für den angegebenen Berichtstyp entsprechen muss, der von HidP_GetCaps in der HIDP_CAPS Struktur der Sammlung zurückgegeben wird.
Rückgabewert
HidP_GetData gibt einen der folgenden status Werte zurück:
| Rückgabecode | Beschreibung |
|---|---|
|
Alle Steuerelementdaten wurden erfolgreich zurückgegeben. |
|
Der durch ReportType angegebene Berichtstyp ist ungültig. |
|
Die von PreparsedData angegebenen vordefinierten Daten sind ungültig. |
|
Die Größe des HID-Berichts in Bytes entspricht nicht der Länge, die in der HIDP_CAPS Struktur der Auflistung für den angegebenen Berichtstyp angegeben ist. |
|
Die Auflistung der obersten Ebene verfügt nicht über einen Bericht des angegebenen Typs. |
|
Das DataList-Array ist zu klein, um alle Schaltflächen zu beschreiben, die derzeit auf ON festgelegt sind, und alle Werte im HID-Bericht. |
Hinweise
Benutzermodusanwendungen und Kernelmodustreiber rufen HidP_MaxDataListLength auf, um die maximal mögliche Anzahl von HIDP_DATA Strukturen zu bestimmen, die HidP_GetData zurückgeben können.
HidP_GetData gibt keine Daten für Nutzungswertarrays zurück.
Weitere Informationen finden Sie unter 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 |