funzione HidP_InitializeReportForID (hidpi.h)

Articolo
02/29/2024

La routine HidP_InitializeReportForID inizializza un report HID.

Sintassi

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parametri

[in] ReportType

Specifica un enumeratore HIDP_REPORT_TYPE che indica il tipo di report HID disponibile in Report.

[in] ReportID

Specifica un ID report.

[in] PreparsedData

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

[out] Report

Puntatore al buffer allocato del chiamante contenente il report HID che HidP_InitializeReportForID inizializza.

[in] ReportLength

Specifica le dimensioni, in byte, del report HID disponibile in Report. ReportLength deve essere uguale alla lunghezza del report della raccolta per il tipo di report specificato, come specificato dai membri XxxReportByteLengthdella struttura HIDP_CAPS di una raccolta.

Valore restituito

HidP_InitializeReportForID restituisce uno dei valori di stato seguenti:

Codice restituito	Descrizione
HIDP_STATUS_SUCCESS	Il report è stato inizializzato correttamente.
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati preparati non sono validi.
HIDP_STATUS_INVALID_REPORT_LENGTH	La lunghezza specificata del report non è uguale alla lunghezza del report della raccolta per il tipo di report specificato.
HIDP_STATUS_INVALID_REPORT_TYPE	Il tipo di report non è valido.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	L'ID del report specificato non è valido.

Commenti

Inizializzare un report HID imposta tutti i dati di controllo su zero o il valore Null di un controllo, come definito dallo standard USB HID. L'invio o la ricezione di un valore Null indica che il valore corrente di un controllo non deve essere modificato.

HidP_InitializeReportForID esegue le operazioni seguenti:

Imposta su zero i campi bit di tutti i pulsanti e i valori senza valori Null.
Imposta il campo bit di tutti i controlli con valori Null sul valore Null corrispondente.

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