StorPortNvmeMiniportEvent 函式 (storport.h)
NVMe 迷你埠驅動程式會呼叫 StorPortNvmeMiniportEvent 函式,將 ETW 事件記錄到具有最多八個額外一般用途參數的特定通道。
語法
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
);
參數
HwDeviceExtension
[in]主機總線適配卡 (HBA) 的硬體裝置擴充功能指標。
ControllerHandle
[in/optional]如果是網狀架構 NVMe (NVMe-oF) 迷你埠,如果事件是控制器特定的,ControllerHandle 為 NVMe 控制器的 Storport 句柄;否則,值為 NULL。
NamespaceId
[in]如果事件是命名空間特定的,NamespaceId 是命名空間標識符;否則,它應該是零。
EventChannel
[in]STORPORT_ETW_EVENT_CHANNEL 列舉值,指定記錄事件的 ETW 通道。
EventId
[in]要唯一識別事件類型的Minipoort特定事件標識碼。
EventDescription
[in]描述事件的必要字串。 字串的大小上限是 STORPORT_ETW_MAX_DESCRIPTION_LENGTH 個字元,不包括 null 終止符。
EventKeywords
[in]STORPORT_ETW_EVENT_CHANNEL_XXX 的位掩碼 值,以進一步描述事件的特性。 如果不需要關鍵詞,請將 設定為零。
EventLevel
[in]指定事件層級的 STORPORT_ETW_LEVEL 值。
EventOpcode
[in]指定事件 opcode 的 STORPORT_ETW_EVENT_OPCODE 列舉值。
Parameter1Name
[in]簡短字串,表示 Parameter1Value意義。 如果 Parameter1Name 為 NULL 或空字串 ,則會忽略 parameter1Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter1Value
[in]第一個參數的值。 如果 Parameter1Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter2Name
[in]簡短字串,表示 Parameter2Value意義。 如果 Parameter2Name 為 NULL 或空字串,則會忽略 Parameter2Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter2Value
[in]第二個參數的值。 如果 Parameter2Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter3Name
[in]簡短字串,表示 Parameter3Value意義。 如果 Parameter3Name 為 NULL 或空字串,則會忽略 parameter3Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter3Value
[in]第三個參數的值。 如果 Parameter3Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter4Name
[in]簡短字串,表示 Parameter4Value意義。 如果 Parameter4Name 為 NULL 或空字串,則會忽略 Parameter4Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter4Value
[in]第四個參數的值。 如果 Parameter4Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter5Name
[in]簡短字串,表示 Parameter5Value意義。 如果 Parameter5Name 為 NULL 或空字串,則會忽略 Parameter5Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter5Value
[in]第五個參數的值。 如果 Parameter5Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter6Name
[in]簡短字串,表示 Parameter6Value意義。 如果 Parameter6Name 為 NULL 或空字串,則會忽略 parameter6Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter6Value
[in]第六個參數的值。 如果 Parameter6Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter7Name
[in]簡短字串,表示 Parameter7Value意義。 如果 Parameter7Name 為 NULL 或空字串,則會忽略 Parameter7Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter7Value
[in]第七個參數的值。 如果 Parameter7Name 為 NULL 或空字串,Storport 會將此值記錄為零。
Parameter8Name
[in]簡短字串,表示 Parameter8Value意義。 如果 Parameter8Name 為 NULL 或空字串 ,則會忽略 Parameter8Value。 字串的大小上限是 STORPORT_ETW_MAX_PARAM_NAME_LENGTH 個字元,不包括 Null 終止符。
Parameter8Value
[in]第八個參數的值。 如果 Parameter8Name 為 NULL 或空字串,Storport 會將此值記錄為零。
傳回值
如果成功記錄事件,StorPortNvmeMiniportEvent 會傳回STOR_STATUS_SUCCESS。 否則,它會傳回值,例如:
傳回碼 | 描述 |
---|---|
STOR_STATUS_NOT_IMPLEMENTED | 此函式不會在作用中的作系統上實作。 |
STOR_STATUS_INVALID_PARAMETER | 如果一或多個參數無效,則作業會失敗並傳回值。 |
STOR_STATUS_UNSUCCESSFUL | 作業因其他內部原因而失敗。 |
言論
迷你埠可以呼叫 StorPortNvmeMiniportEvent 來記錄八個一般用途 ETW 參數。 ETW 參數會以八個名稱/值組表示。 如果未命名參數 (ParameterXName = NULL),例程會將對應的參數值設定為 0。
從 StorPort 迷你埠驅動程式產生的事件會記錄在 eventChannel 所指定的通道中。
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 11 版本 24H2 |
標頭 | storport.h |