StorPortEtwChannelEvent2, fonction (storport.h)

Article
02/07/2025

Un miniport appelle StorPortEtwChannelEvent2 pour consigner un événement ETW avec deux paramètres ETW universels sur un canal spécifié.

Syntaxe

ULONG StorPortEtwChannelEvent2(
  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
);

Paramètres

HwDeviceExtension

[in] Pointeur vers l’extension de périphérique matériel pour l’adaptateur de bus hôte (HBA).

Address

[in/optional] Adresse de l’unité de stockage. Ce paramètre a la valeur NULL pour les périphériques d’adaptateur.

EventChannel

[in] Valeur STORPORT_ETW_EVENT_CHANNEL qui spécifie le canal Storport sur lequel consigner l’événement.

EventId

[in] Identificateur miniport défini pour identifier de manière unique le type d’événement.

EventDescription

[in] Chaîne requise qui décrit l’événement. La taille maximale de la chaîne est STORPORT_ETW_MAX_DESCRIPTION_LENGTH caractères, sans inclure la marque de fin Null.

EventKeywords

[in] Indicateurs de mot clé pour la catégorisation des événements. Définissez la valeur 0 si aucun mot clé n’est souhaité. Les mots clés sont une combinaison OR au niveau du bit des éléments suivants.

Valeur	Signification
STORPORT_ETW_EVENT_KEYWORD_IO	L’événement est lié aux opérations d’E/S de l’appareil.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	L’événement est lié aux performances.
STORPORT_ETW_EVENT_KEYWORD_POWER	L’événement est lié à l’alimentation de l’appareil.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	L’événement est lié à l’énumération de l’appareil.

EventLevel

[in] Valeur STORPORT_ETW_LEVEL qui spécifie l’importance ou la gravité de l’événement.

EventOpcode

[in] Valeur STORPORT_ETW_EVENT_OPCODE qui spécifie la nature opérationnelle de l’événement.

Srb

[in] Pointeur vers le SRB associé à l’événement journalisé. Si ce paramètre contient un SRB valide, ce pointeur SRB et le pointeur SRB associé sont enregistrés.

Parameter1Name

[in] Description de la signification de Parameter1Value. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.

Parameter1Value

[in] Valeur du paramètre 1.

Parameter2Name

[in] Description de la signification de Parameter2Value. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.

Parameter2Value

[in] Valeur du paramètre 2.

Valeur de retour

StorPortEtwChannelEvent2 retourne l’un des codes d’état suivants :

Retourner le code	Description
STOR_STATUS_SUCCESS	L’événement a été correctement journalisé.
STOR_STATUS_NOT_IMPLEMENTED	Le suivi n’est pas activé pour les événements de stockage.
STOR_STATUS_INVALID_PARAMETER	L’un des paramètres n’est pas valide. Par exemple, HwDeviceExtension ou EventDescription sont NULL, EventDescription est supérieur à la longueur de nom maximale, ou un nom de paramètre ETW est supérieur à la longueur maximale du nom.

Remarques

Un miniport peut appeler StorPortEtwChannelEvent2 pour journaliser deux paramètres ETW à usage général. Les paramètres ETW sont exprimés sous la forme de deux paires nom-valeur. Si un paramètre n’est pas nommé (ParamètreXName = NULL), la routine définit la valeur de paramètre correspondante sur 0.

Les événements générés à partir de pilotes miniport StorPort sont enregistrés dans le canal spécifié par EventChannel.