funzione HidP_GetData (hidpi.h)

Articolo
02/26/2024

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 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 di enumeratore HIDP_REPORT_TYPE che indica il tipo di report HID disponibile in Report.

[out] DataList

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

[in, out] DataLength

Specifica, in input, il numero di strutture che la matrice DataList allocata dal chiamante contiene. Specifica, in 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 di controllo.

[in] PreparsedData

Puntatore ai dati preparati della raccolta di primo livello associato al report HID situato in Report.

[in] Report

Puntatore a un report HID.

[in] ReportLength

Specifica le dimensioni, in byte, del report HID situato 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 primo livello non include un report del tipo specificato.
HIDP_STATUS_BUFFER_TOO_SMALL	La matrice DataList è troppo piccola per descrivere tutti i pulsanti, attualmente impostata su ON e tutti i valori nel report HID.

Commenti

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 i dati per le matrici di valori di utilizzo.

Per altre informazioni, vedere Raccolte HID.

Requisiti

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

Vedi anche

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA

Condividi tramite