StorPortNvmeMiniportEvent-Funktion (storport.h)
Ein NVMe-Miniporttreiber ruft die StorPortNvmeMiniportEvent--Funktion auf, um ein ETW-Ereignis in einem bestimmten Kanal mit bis zu acht zusätzlichen allgemeinen Parametern zu protokollieren.
Syntax
ULONG StorPortNvmeMiniportEvent(
PVOID HwDeviceExtension,
PVOID ControllerHandle,
ULONG NamespaceId,
STORPORT_ETW_EVENT_CHANNEL EventChannel,
ULONG EventId,
PWSTR EventDescription,
ULONGLONG EventKeywords,
STORPORT_ETW_LEVEL EventLevel,
STORPORT_ETW_EVENT_OPCODE EventOpcode,
_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,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter5Name,
ULONGLONG Parameter5Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter6Name,
ULONGLONG Parameter6Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter7Name,
ULONGLONG Parameter7Value,
_In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter8Name,
ULONGLONG Parameter8Value
);
Parameter
HwDeviceExtension
[in] Ein Zeiger auf die Hardwaregeräteerweiterung für den Hostbusadapter (HBA).
ControllerHandle
[in/optional] Bei einem Fabric NVMe(NVMe-oF)-Miniport, wenn das Ereignis controllerspezifisch ist, ControllerHandle- der Handle von Storport für den NVMe-Controller ist; andernfalls ist der Wert NULL.
NamespaceId
[in] Wenn das Ereignis namespacespezifisch ist, ist NamespaceId der Namespacebezeichner; andernfalls sollte es null sein.
EventChannel
[in] Ein STORPORT_ETW_EVENT_CHANNEL Enumerationswert, der den ETW-Kanal angibt, in dem das Ereignis protokolliert wird.
EventId
[in] Minipoort-spezifischer Ereignisbezeichner, um den Ereignistyp eindeutig zu identifizieren.
EventDescription
[in] Erforderliche Zeichenfolge, die das Ereignis beschreibt. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_DESCRIPTION_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
EventKeywords
[in] Bitmaske von STORPORT_ETW_EVENT_CHANNEL_XXX- Werten zur weiteren Charakterisierung des Ereignisses. Wird auf Null festgelegt, wenn keine Schlüsselwörter erforderlich sind.
EventLevel
[in] Ein STORPORT_ETW_LEVEL Wert, der die Ebene des Ereignisses angibt.
EventOpcode
[in] Ein STORPORT_ETW_EVENT_OPCODE Enumerationswert, der den Opcode des Ereignisses angibt.
Parameter1Name
[in] Eine kurze Zeichenfolge, die Parameter1Value-bedeutung. Wenn Parameter1Name- NULL oder eine leere Zeichenfolge ist, wird Parameter1Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter1Value
[in] Der Wert des ersten Parameters. Wenn Parameter1Name- NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter2Name
[in] Eine kurze Zeichenfolge, die Parameter2Value-bedeutung. Wenn Parameter2Name- NULL oder eine leere Zeichenfolge ist, wird Parameter2Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter2Value
[in] Der Wert des zweiten Parameters. Wenn Parameter2Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter3Name
[in] Eine kurze Zeichenfolge, die Parameter3Value-bedeutung. Wenn Parameter3Name- NULL oder eine leere Zeichenfolge ist, wird Parameter3Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter3Value
[in] Der Wert des dritten Parameters. Wenn Parameter3Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter4Name
[in] Eine kurze Zeichenfolge, die Parameter4Value-bedeutung. Wenn Parameter4Name- NULL oder eine leere Zeichenfolge ist, wird Parameter4Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter4Value
[in] Der Wert des vierten Parameters. Wenn Parameter4Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter5Name
[in] Eine kurze Zeichenfolge, die Parameter5Value-bedeutung. Wenn Parameter5Name- NULL oder eine leere Zeichenfolge ist, wird Parameter5Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter5Value
[in] Der Wert des fünften Parameters. Wenn Parameter5Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter6Name
[in] Eine kurze Zeichenfolge, die Parameter6Value-bedeutung. Wenn Parameter6Name- NULL oder eine leere Zeichenfolge ist, wird Parameter6Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter6Value
[in] Der Wert des sechsten Parameters. Wenn Parameter6Name- NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter7Name
[in] Eine kurze Zeichenfolge, die Parameter7Value-bedeutung. Wenn Parameter7Name NULL oder eine leere Zeichenfolge ist, wird Parameter7Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter7Value
[in] Der Wert des siebten Parameters. Wenn Parameter7Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Parameter8Name
[in] Eine kurze Zeichenfolge, die Parameter8Value-bedeutung. Wenn Parameter8Name- NULL oder eine leere Zeichenfolge ist, wird Parameter8Value- ignoriert. Die maximale Größe der Zeichenfolge ist STORPORT_ETW_MAX_PARAM_NAME_LENGTH Zeichen, nicht einschließlich des Null-Terminators.
Parameter8Value
[in] Der Wert des achten Parameters. Wenn Parameter8Name NULL oder eine leere Zeichenfolge ist, protokolliert Storport diesen Wert als Null.
Rückgabewert
StorPortNvmeMiniportEvent gibt eine STOR_STATUS_SUCCESS zurück, wenn das Ereignis erfolgreich protokolliert wird. Andernfalls wird ein Wert zurückgegeben, z. B.:
Rückgabecode | Beschreibung |
---|---|
STOR_STATUS_NOT_IMPLEMENTED | Diese Funktion ist nicht auf dem aktiven Betriebssystem implementiert. |
STOR_STATUS_INVALID_PARAMETER | Der Vorgang schlägt mit diesem Rückgabewert fehl, wenn mindestens ein Parameter ungültig ist. |
STOR_STATUS_UNSUCCESSFUL | Der Vorgang ist aus anderen internen Gründen fehlgeschlagen. |
Bemerkungen
Ein Miniport kann StorPortNvmeMiniportEvent- aufrufen, um acht allgemeine ETW-Parameter zu protokollieren. Die ETW-Parameter werden als acht Name-Wert-Paare ausgedrückt. Wenn ein Parameter nicht benannt ist (ParameterXName = NULL), legt die Routine den entsprechenden Parameterwert auf 0 fest.
Ereignisse, die von StorPort-Miniporttreibern generiert werden, werden im kanal protokolliert, der durch EventChannelangegeben wird.
Anforderungen
Anforderung | Wert |
---|---|
mindestens unterstützte Client- | Windows 11, Version 24H2 |
Header- | storport.h |