StorPortEtwLogByteStream-Funktion (storport.h)

Artikel
02/07/2025

StorPortEtwLogByteStream protokolliert ein Ereignisablaufverfolgungsereignis für Windows (ETW) mit einem allgemeinen Bytestreamparameter für den angegebenen Kanal.

Syntax

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

Parameter

[in] HwDeviceExtension

Ein Zeiger auf die Geräteerweiterung des Miniports.

[in, optional] Address

Die Adresse des Speichergeräts. Dieser Parameter ist NULL für Adaptergeräte.

[in] EventChannel

Ein STORPORT_ETW_EVENT_CHANNEL Wert, der den ETW-Kanal identifiziert, in dem das Ereignis protokolliert werden soll.

[in] EventId

Eine miniportdefinierte Ereignis-ID, die das Ereignis eindeutig identifiziert.

[in] EventDescription

Eine kurze Zeichenfolge, die das Ereignis beschreibt. EventDescription- ist erforderlich und muss <= STORPORT_ETW_MAX_DESCRIPTION_LENGTH Zeichen sein, nicht einschließlich des NULL-Terminators.

[in] EventKeywords

Stichwortkennzeichnungen für die Ereigniskategorisierung. Legen Sie auf 0 fest, wenn kein Schlüsselwort gewünscht wird. Die Schlüsselwörter sind eine bitweise ODER-Kombination der folgenden.

Wert	Bedeutung
STORPORT_ETW_EVENT_KEYWORD_IO	Das Ereignis bezieht sich auf Geräte-E/A-Vorgänge.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	Das Ereignis bezieht sich auf die Leistung.
STORPORT_ETW_EVENT_KEYWORD_POWER	Das Ereignis bezieht sich auf die Geräteleistung.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	Das Ereignis bezieht sich auf die Geräteaufzählung.

[in] EventLevel

Die Ereignisebene. Dieser Wert kann die Wichtigkeit oder den Schweregrad des Ereignisses angeben. Dies ist einer der folgenden Werte.

Wert	Bedeutung
StorportEtwLevelLogAlways	Protokollieren Sie das Ereignis bedingungslos. Das Ereignis wird unabhängig von den festgelegten Filtern protokolliert.
StorportEtwLevelCritical	Ereignis der kritischen Ebene.
StorportEtwLevelError	Ereignis auf Fehlerebene.
StorportEtwLevelWarning	Ereignis auf Warnstufe.
StorportEtwLevelInformational	Informationsereignis.
StorportEtwLevelVerbose	Ausführliche Ereignisinformationen bereitgestellt.

[in] EventOpcode

Der operative Charakter des Ereignisses. Dies ist einer der folgenden Werte.

Wert	Bedeutung
StorportEtwEventOpcodeInfo	Allgemeines Informationsereignis.
StorportEtwEventOpcodeStart	Das Gerät oder die Einheit wurde gestartet.
StorportEtwEventOpcodeStop	Das Gerät oder die Einheit wurde beendet. Das Ereignis entspricht dem letzten entkoppelten Startereignis.
StorportEtwEventOpcodeDC_Start	Ein Startereignis für eine Datensammlung. Hierbei handelt es sich um Rundown-Ereignistypen.
StorportEtwEventOpcodeDC_Stop	Ein Ereignis zum Beenden einer Datensammlung. Hierbei handelt es sich um Rundown-Ereignistypen.
StorportEtwEventOpcodeExtension	Ein Erweiterungsereignis.
StorportEtwEventOpcodeReply	Ein Antwortereignis.
StorportEtwEventOpcodeResume	Das Gerät oder die Einheit wurde nach dem Anhalten fortgesetzt.
StorportEtwEventOpcodeSuspend	Das Gerät oder die Einheit wird angehalten, bis der Abschluss eines anderen Vorgangs abgeschlossen ist.
StorportEtwEventOpcodeReceive	Die Übertragung der Aktivität wird von einer anderen Komponente empfangen.

[in] DataLength

Die Länge des Bytedatenstroms, der Daten punktiert, wobei 1 <= DataLength<= STORPORT_ETW_MAX_BYTE_STREAM_LENGTH.

[in] Data

Zeiger auf den benutzerdefinierten ETW-Bytedatenstrom des Miniports.

Rückgabewert

StorPortEtwLogByteStream gibt einen der folgenden Statuscodes zurück:

Rückgabecode	Beschreibung
STOR_STATUS_SUCCESS	Das Ereignis wurde erfolgreich beim angegebenen ETW-Kanal protokolliert.
STOR_STATUS_INVALID_PARAMETER	Ein Parameter ist ungültig. Beispielsweise sind HwDeviceExtension, EventDescriptionoder Data NULL, DataLength- größer als die maximale Namenslänge ist, EventChannel- ein ungültiger Wert ist.
STOR_STATUS_UNSUCCESSFUL	Wird aus anderen internen Gründen zurückgegeben.

Bemerkungen

Ein Miniport kann StorPortEtwLogByteStream- aufrufen, um ein ETW-Ereignis in einem bestimmten Kanal mit einem allgemeinen Bytestreamparameter zu protokollieren.

StorPortEtwLogByteStream- ist nützlich, wenn ein Miniport über den zulässigen Kontext hinaus in StorPortEtwEvent2, StorPortEtwEvent4oder StorPortEtwEvent8protokolliert werden muss. Beispielsweise kann ein Miniport seine interne Datenstruktur als Bytedatenstrom protokollieren, der dann für Diagnosezwecke verwendet werden kann, wenn Probleme gemeldet werden.