funzione HidP_GetData (hidpi.h)

Articolo
02/07/2025

La routine HidP_GetData restituisce, per un report specificato, una matrice di strutture HIDP_DATA che identificano gli indici di dati di tutti i pulsanti di controllo HID attualmente impostati su ON (1) e gli indici di dati e i dati associati a tutti i valori di controllo HID.

Sintassi

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
);

Parametri

[in] ReportType

Specifica un valore enumeratore HIDP_REPORT_TYPE che indica il tipo di report HID che si trova in Report.

[out] DataList

Specifica una matrice allocata dal chiamante di strutture HIDP_DATA utilizzate dalla routine per restituire informazioni su tutti i pulsanti attualmente impostati su ON e i dati associati ai valori.

[in, out] DataLength

Specifica, in base all'input, il numero di strutture che il chiamante allocato DataList matrice contiene. Specifica, nell'output, il numero di controlli per i quali la routine può restituire dati, che include tutti i pulsanti attualmente impostati su ON e tutti i valori dei controlli.

[in] PreparsedData

Puntatore al prepara i dati della raccolta di livello superiore associata al report HID disponibile in Report.

[in] Report

Puntatore a un report HID.

[in] ReportLength

Specifica le dimensioni, in byte, del report HID che si trova in Report, che deve essere uguale alla lunghezza del report per il tipo di report specificato restituito da HidP_GetCaps nella struttura HIDP_CAPS dell'insieme.

Valore restituito

HidP_GetData restituisce uno dei valori di stato seguenti:

Codice restituito	Descrizione
HIDP_STATUS_SUCCESS	Tutti i dati del controllo sono stati restituiti correttamente.
HIDP_STATUS_INVALID_REPORT_TYPE	Il tipo di report specificato da ReportType non è valido
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati preparati specificati da PreparsedData non sono validi
HIDP_STATUS_INVALID_REPORT_LENGTH	Le dimensioni, in byte, del report HID non sono uguali alla lunghezza specificata nella struttura HIDP_CAPS della raccolta per il tipo di report specificato.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	La raccolta di livello superiore non dispone di un report del tipo specificato.
HIDP_STATUS_BUFFER_TOO_SMALL	La matrice di DataList è troppo piccola per descrivere tutti i pulsanti, attualmente impostato su ON e tutti i valori nel report HID.

Osservazioni

Le applicazioni in modalità utente e i driver in modalità kernel chiamano HidP_MaxDataListLength per determinare il numero massimo possibile di strutture HIDP_DATA che HidP_GetData possono restituire.

HidP_GetData non restituisce dati per le matrici di valori di utilizzo .

Per altre informazioni, vedere raccolte HID.

Fabbisogno

Requisito	Valore
client minimo supportato	Disponibile in Windows 2000 e versioni successive di Windows.
piattaforma di destinazione	Universale
intestazione	hidpi.h (include Hidpi.h)
libreria	Hidparse.lib
IRQL	<= DISPATCH_LEVEL

Vedere anche

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA

Condividi tramite