StorPortEtwLogByteStream, fonction (storport.h)

Article
02/07/2025

StorPortEtwLogByteStream journalise un événement Suivi d’événements pour Windows (ETW) avec un paramètre de flux d’octets universel sur le canal spécifié.

Syntaxe

ULONG StorPortEtwLogByteStream(
  [in]           PVOID                      HwDeviceExtension,
  [in, optional] PSTOR_ADDRESS              Address,
  [in]           STORPORT_ETW_EVENT_CHANNEL EventChannel,
  [in]           ULONG                      EventId,
  [in]           PWSTR                      EventDescription,
  [in]           ULONGLONG                  EventKeywords,
  [in]           STORPORT_ETW_LEVEL         EventLevel,
  [in]           STORPORT_ETW_EVENT_OPCODE  EventOpcode,
  [in]           USHORT                     DataLength,
  [in]           PUCHAR                     Data
);

Paramètres

[in] HwDeviceExtension

Pointeur vers l’extension d’appareil du miniport.

[in, optional] Address

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

[in] EventChannel

Valeur STORPORT_ETW_EVENT_CHANNEL qui identifie le canal ETW dans lequel consigner l’événement.

[in] EventId

ID d’événement défini par miniport qui identifie de façon unique l’événement.

[in] EventDescription

Chaîne courte décrivant l’événement. EventDescription est obligatoire et doit être <= STORPORT_ETW_MAX_DESCRIPTION_LENGTH caractères, sans inclure le terminateur NULL.

[in] EventKeywords

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.

[in] EventLevel

Niveau d’événement. Cette valeur peut indiquer l’importance ou la gravité de l’événement. Il s’agit de l’une des valeurs suivantes.

Valeur	Signification
StorportEtwLevelLogAlways	Journaliser l’événement de manière inconditionnelle. L’événement est journalisé indépendamment des filtres définis.
StorportEtwLevelCritical	Événement de niveau critique.
StorportEtwLevelError	Événement de niveau d’erreur.
StorportEtwLevelWarning	Événement au niveau de l’avertissement.
StorportEtwLevelInformational	Événement informationnel.
StorportEtwLevelVerbose	Informations détaillées sur les événements fournis.

[in] EventOpcode

Nature opérationnelle de l’événement. Il s’agit de l’une des valeurs suivantes.

Valeur	Signification
StorportEtwEventOpcodeInfo	Événement d’information général.
StorportEtwEventOpcodeStart	L’appareil ou l’unité a démarré.
StorportEtwEventOpcodeStop	L’appareil ou l’unité s’arrêtait. L’événement correspond à l’événement de début non souhaité.
StorportEtwEventOpcodeDC_Start	Événement de démarrage de collecte de données. Il s’agit de types d’événements d’exécution.
StorportEtwEventOpcodeDC_Stop	Événement d’arrêt de collecte de données. Il s’agit de types d’événements d’exécution.
StorportEtwEventOpcodeExtension	Événement d’extension.
StorportEtwEventOpcodeReply	Événement de réponse.
StorportEtwEventOpcodeResume	L’appareil ou l’unité a repris après l’interruption.
StorportEtwEventOpcodeSuspend	L’appareil ou l’unité est suspendu en attente d’achèvement d’une autre opération.
StorportEtwEventOpcodeReceive	Le transfert d’activité est reçu d’un autre composant.

[in] DataLength

Longueur, en octets, du flux d’octets vers lequel Data pointe, où 1 <= DataLength<= STORPORT_ETW_MAX_BYTE_STREAM_LENGTH.

[in] Data

Pointeur vers le flux d’octets ETW personnalisé du miniport.

Valeur de retour

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

Retourner le code	Description
STOR_STATUS_SUCCESS	L’événement a été correctement journalisé sur le canal ETW spécifié.
STOR_STATUS_INVALID_PARAMETER	Un paramètre n’est pas valide. Par exemple, HwDeviceExtension, EventDescriptionou Data sont NULL, DataLength est supérieur à la longueur maximale du nom, EventChannel est une valeur non valide.
STOR_STATUS_UNSUCCESSFUL	Retourné pour d’autres raisons internes.

Remarques

Un miniport peut appeler StorPortEtwLogByteStream pour consigner un événement ETW sur un canal spécifique avec un paramètre de flux d’octets universel.

StorPortEtwLogByteStream est utile lorsqu’un miniport doit journaliser le contexte au-delà de celui autorisé dans StorPortEtwEvent2, StorPortEtwEvent4ou StorPortEtwEvent8. Par exemple, un miniport peut consigner sa structure de données interne en tant que flux d’octets qui peut ensuite être utilisé à des fins de diagnostic lorsque les problèmes sont signalés.