Функция StorPortEtwChannelEvent4 (storport.h)

Статья
02/07/2025

Минипорт вызывает StorPortEtwChannelEvent4 регистрировать событие ETW с четырьмя параметрами ETW общего назначения в указанный канал.

Синтаксис

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

Параметры

HwDeviceExtension

[in] Указатель на расширение аппаратного устройства для адаптера шины узла (HBA).

Address

[in/необязательный] Адрес устройства единицы хранения. Этот параметр имеет значение NULL для устройств адаптера.

EventChannel

[in] Значение STORPORT_ETW_EVENT_CHANNEL, указывающее канал Storport, на котором следует регистрировать событие.

EventId

[in] Минипорт-определенный идентификатор для уникального определения типа события.

EventDescription

[in] Требуемая строка, описывающая событие. Максимальный размер строки — это STORPORT_ETW_MAX_DESCRIPTION_LENGTH символов, не включая терминатор NULL.

EventKeywords

[in] Флаги ключевых слов для классификации событий. Установите значение 0, если ключевое слово не требуется. Ключевые слова — это побитовая комбинация OR из следующих значений.

Ценность	Значение
STORPORT_ETW_EVENT_KEYWORD_IO	Это событие связано с операциями ввода-вывода устройства.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	Событие связано с производительностью.
STORPORT_ETW_EVENT_KEYWORD_POWER	Это событие связано с питанием устройства.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	Событие связано с перечислением устройств.

EventLevel

[in] Значение STORPORT_ETW_LEVEL, указывающее важность или серьезность события.

EventOpcode

[in] Значение STORPORT_ETW_EVENT_OPCODE, указывающее операционный характер события.

Srb

[in] Указатель на SRB, связанный с зарегистрированным событием. Если этот параметр содержит допустимый SRB, этот указатель SRB и связанный указатель SRB регистрируются.

Parameter1Name

[in] Описание значения Parameter1Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

Parameter1Value

[in] Значение параметра 1.

Parameter2Name

[in] Описание значения Parameter2Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

Parameter2Value

[in] Значение параметра 2.

Parameter3Name

[in] Описание значения Parameter3Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

Parameter3Value

[in] Значение параметра 3.

Parameter4Name

[in] Описание значения Parameter4Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

Parameter4Value

[in] Значение параметра 4.

Возвращаемое значение

StorPortEtwChannelEvent4 возвращает один из следующих кодов состояния:

Возвращаемый код	Описание
STOR_STATUS_SUCCESS	Событие успешно зарегистрировано.
STOR_STATUS_NOT_IMPLEMENTED	Трассировка не включена для событий хранилища.
STOR_STATUS_INVALID_PARAMETER	Один из параметров недопустим. Например, HwDeviceExtension или EventDescription имеют значение NULL, EventDescription превышает максимальную длину имени или имя параметра ETW больше максимальной длины имени.

Замечания

Минипорт может вызывать StorPortEtwChannelEvent4 для регистрации четырех параметров etw общего назначения. Параметры ETW выражаются как четыре пары "имя-значение". Если параметр не называется (параметрXName = NULL), подпрограмма присвоит соответствующему значению параметра значение 0.

События, созданные из драйверов минипорта StorPort, регистрируются в канале, указанном EventChannel.