Funzione StorPortEtwChannelEvent4 (storport.h)

Articolo
02/07/2025

Un miniport chiama StorPortEtwChannelEvent4 per registrare un evento ETW con quattro parametri ETW per utilizzo generico a un canale specificato.

Sintassi

ULONG StorPortEtwChannelEvent4(
  PVOID                                                        HwDeviceExtension,
  PSTOR_ADDRESS                                                Address,
  STORPORT_ETW_EVENT_CHANNEL                                   EventChannel,
  ULONG                                                        EventId,
  PWSTR                                                        EventDescription,
  ULONGLONG                                                    EventKeywords,
  STORPORT_ETW_LEVEL                                           EventLevel,
  STORPORT_ETW_EVENT_OPCODE                                    EventOpcode,
  PSCSI_REQUEST_BLOCK                                          Srb,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter1Name,
  ULONGLONG                                                    Parameter1Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter2Name,
  ULONGLONG                                                    Parameter2Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter3Name,
  ULONGLONG                                                    Parameter3Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter4Name,
  ULONGLONG                                                    Parameter4Value
);

Parametri

HwDeviceExtension

[in] Puntatore all'estensione del dispositivo hardware per la scheda bus host (HBA).

Address

[in/facoltativo] Indirizzo del dispositivo dell'unità di archiviazione. Questo parametro è NULL per i dispositivi adattatori.

EventChannel

[in] Valore STORPORT_ETW_EVENT_CHANNEL che specifica il canale Storport in cui registrare l'evento.

EventId

[in] Identificatore definito dal miniport per identificare in modo univoco il tipo di evento.

EventDescription

[in] Stringa obbligatoria che descrive l'evento. La dimensione massima della stringa è STORPORT_ETW_MAX_DESCRIPTION_LENGTH caratteri, senza includere il carattere di terminazione Null.

EventKeywords

[in] Flag di parole chiave per la categorizzazione degli eventi. Impostare su 0 se non si desidera alcuna parola chiave. Le parole chiave sono una combinazione OR bit per bit delle opzioni seguenti.

Valore	Significato
STORPORT_ETW_EVENT_KEYWORD_IO	L'evento è correlato alle operazioni di I/O del dispositivo.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	L'evento è correlato alle prestazioni.
STORPORT_ETW_EVENT_KEYWORD_POWER	L'evento è correlato all'alimentazione del dispositivo.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	L'evento è correlato all'enumerazione del dispositivo.

EventLevel

[in] Valore STORPORT_ETW_LEVEL che specifica l'importanza o la gravità dell'evento.

EventOpcode

[in] Valore STORPORT_ETW_EVENT_OPCODE che specifica la natura operativa dell'evento.

Srb

[in] Puntatore a SRB associato all'evento registrato. Se questo parametro contiene un SRB valido, questo puntatore SRB e il puntatore SRB associato vengono registrati.

Parameter1Name

[in] Descrizione del significato di Parameter1Value. La dimensione massima della stringa è STORPORT_ETW_MAX_PARAM_NAME_LENGTH caratteri, senza includere il carattere di terminazione Null.

Parameter1Value

[in] Valore per il parametro 1.

Parameter2Name

[in] Descrizione del significato di Parameter2Value. La dimensione massima della stringa è STORPORT_ETW_MAX_PARAM_NAME_LENGTH caratteri, senza includere il carattere di terminazione Null.

Parameter2Value

[in] Valore per il parametro 2.

Parameter3Name

[in] Descrizione del significato di Parameter3Value. La dimensione massima della stringa è STORPORT_ETW_MAX_PARAM_NAME_LENGTH caratteri, senza includere il carattere di terminazione Null.

Parameter3Value

[in] Valore per il parametro 3.

Parameter4Name

[in] Descrizione del significato di Parameter4Value. La dimensione massima della stringa è STORPORT_ETW_MAX_PARAM_NAME_LENGTH caratteri, senza includere il carattere di terminazione Null.

Parameter4Value

[in] Valore per il parametro 4.

Valore restituito

StorPortEtwChannelEvent4 restituisce uno dei codici di stato seguenti:

Codice restituito	Descrizione
STOR_STATUS_SUCCESS	L'evento è stato registrato correttamente.
STOR_STATUS_NOT_IMPLEMENTED	La traccia non è abilitata per gli eventi di archiviazione.
STOR_STATUS_INVALID_PARAMETER	Uno dei parametri non è valido. Ad esempio, HwDeviceExtension o EventDescription sono NULL, EventDescription è maggiore della lunghezza massima del nome o un nome di parametro ETW è maggiore della lunghezza massima del nome.

Osservazioni

Un miniport può chiamare StorPortEtwChannelEvent4 per registrare quattro parametri ETW per utilizzo generico. I parametri ETW sono espressi come quattro coppie nome-valore. Se un parametro non è denominato (parametroXName = NULL), la routine imposta il valore del parametro corrispondente su 0.

Gli eventi generati dai driver miniport StorPort vengono registrati nel canale specificato da EventChannel.