StorPortEtwLogByteStream-Funktion (storport.h)

Artikel
02/26/2024

StorPortEtwLogByteStream protokolliert ein ETW-Ereignis (Event Tracing for Windows) mit einem universellen 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 Geräteadresse der Speichereinheit. Dieser Parameter ist NULL für Adaptergeräte.

[in] EventChannel

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

[in] EventId

Eine durch Miniport definierte 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 ohne NULL-Abschlusszeichen sein <.

[in] EventKeywords

Schlüsselwortflags für die Ereigniskategorisierung. Legen Sie auf 0 fest, wenn keine Schlüsselwort (keyword) gewünscht ist. Bei den Schlüsselwörtern handelt es sich um eine bitweise OR-Kombination der folgenden Elemente.

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 ist leistungsbezogen.
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 beliebigen Filtereinstellungen protokolliert.
StorportEtwLevelCritical	Ereignis auf kritischer Ebene.
StorportEtwLevelError	Fehlerebenenereignis.
StorportEtwLevelWarning	Ereignis der Warnungsstufe.
StorportEtwLevelInformational	Informationsereignis.
StorportEtwLevelVerbose	Ausführliche Ereignisinformationen bereitgestellt.

[in] EventOpcode

Der betriebliche 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 unbezahlten Startereignis.
StorportEtwEventOpcodeDC_Start	Ein Datensammlungsstartereignis. Hierbei handelt es sich um Rundownereignistypen.
StorportEtwEventOpcodeDC_Stop	Ein Ereignis zum Beenden der Datensammlung. Hierbei handelt es sich um Rundownereignistypen.
StorportEtwEventOpcodeExtension	Ein Erweiterungsereignis.
StorportEtwEventOpcodeReply	Ein Antwortereignis.
StorportEtwEventOpcodeResume	Das Gerät oder die Einheit wurde nach dem Anhalten wieder fortgesetzt.
StorportEtwEventOpcodeSuspend	Das Gerät oder die Einheit wird bis zum Abschluss eines anderen Vorgangs angehalten.
StorportEtwEventOpcodeReceive	Die Übertragung der Aktivität wird von einer anderen Komponente empfangen.

[in] DataLength

Länge des Bytestroms, auf den Data verweist, wobei 1 <= DataLength<= STORPORT_ETW_MAX_BYTE_STREAM_LENGTH.

[in] Data

Zeiger auf den benutzerdefinierten ETW-Bytestream des Miniports.

Rückgabewert

StorPortEtwLogByteStream gibt einen der folgenden status-Codes 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, EventDescription oder Data NULL, DataLength ist größer als die maximale Namenslänge, EventChannel ist ein ungültiger Wert.
STOR_STATUS_UNSUCCESSFUL	Wird aus anderen internen Gründen zurückgegeben.

Hinweise

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

StorPortEtwLogByteStream ist nützlich, wenn ein Miniport einen Kontext über den in StorPortEtwEvent2, StorPortEtwEvent4 oder StorPortEtwEvent8 zulässigen Kontext protokollieren muss. Für instance kann ein Miniport seine interne Datenstruktur als Bytedatenstrom protokollieren, der dann für Diagnosezwecke verwendet werden kann, wenn Probleme gemeldet werden.