StorPortNvmeMiniportEvent 関数 (storport.h)
NVMe ミニポート ドライバーは、StorPortNvmeMiniportEvent 関数を呼び出して、最大 8 つの追加の汎用パラメーターを使用して特定のチャネルに 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
[入力/省略可能]ファブリック NVMe (NVMe-oF) ミニポートの場合、イベントがコントローラー固有の場合、ControllerHandle は NVMe コントローラーの Storport のハンドルです。それ以外の場合、値は NULL です。
NamespaceId
[in]イベントが名前空間固有の場合、NamespaceId は名前空間識別子です。それ以外の場合は 0 にする必要があります。
EventChannel
[in]イベントがログに記録される ETW チャネルを指定する STORPORT_ETW_EVENT_CHANNEL 列挙値。
EventId
[in]イベントの種類を一意に識別するためのミニポート固有のイベント識別子。
EventDescription
[in]イベントを説明する必須の文字列。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_DESCRIPTION_LENGTH 文字です。
EventKeywords
[in]イベントをさらに特徴付けるために、STORPORT_ETW_EVENT_CHANNEL_XXX 値のビットマスク。 キーワードが必要ない場合は、0 に設定します。
EventLevel
[in]イベントのレベルを指定する STORPORT_ETW_LEVEL 値。
EventOpcode
[in]イベントのオペコードを指定する STORPORT_ETW_EVENT_OPCODE 列挙値。
Parameter1Name
[in]Parameter1Value 意味を与える短い文字列。 Parameter1Name が NULL または空の文字列の場合、Parameter1Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter1Value
[in]最初のパラメーターの値。 Parameter1Name が NULL または空の文字列の場合、Storport はこの値をゼロとしてログに記録します。
Parameter2Name
[in]Parameter2Value を意味を与える短い文字列。 Parameter2Name が NULL または空の文字列の場合、Parameter2Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter2Value
[in]2 番目のパラメーターの値。 Parameter2Name が NULL または空の文字列の場合、Storport はこの値を 0 としてログに記録します。
Parameter3Name
[in]Parameter3Value を意味を与える短い文字列。 Parameter3Name が NULL または空の文字列の場合、Parameter3Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter3Value
[in]3 番目のパラメーターの値。 Parameter3Name が NULL または空の文字列の場合、Storport はこの値をゼロとしてログに記録します。
Parameter4Name
[in]Parameter4Value を意味を与える短い文字列。 Parameter4Name が NULL または空の文字列の場合、Parameter4Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter4Value
[in]4 番目のパラメーターの値。 Parameter4Name が NULL または空の文字列の場合、Storport はこの値をゼロとしてログに記録します。
Parameter5Name
[in]Parameter5Value を意味を与える短い文字列。 Parameter5Name が NULL または空の文字列の場合、Parameter5Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter5Value
[in]5 番目のパラメーターの値。 Parameter5Name が NULL または空の文字列の場合、Storport はこの値を 0 としてログに記録します。
Parameter6Name
[in]Parameter6Value を意味を与える短い文字列。 Parameter6Name が NULL または空の文字列の場合、Parameter6Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter6Value
[in]6 番目のパラメーターの値。 Parameter6Name が NULL または空の文字列の場合、Storport はこの値を 0 としてログに記録します。
Parameter7Name
[in]Parameter7Value を意味を与える短い文字列。 Parameter7Name が NULL または空の文字列の場合、Parameter7Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter7Value
[in]7 番目のパラメーターの値。 Parameter7Name が NULL または空の文字列の場合、Storport はこの値を 0 としてログに記録します。
Parameter8Name
[in]Parameter8Value を意味を与える短い文字列。 Parameter8Name が NULL または空の文字列の場合、Parameter8Value は無視されます。 文字列の最大サイズは、null ターミネータを含まない STORPORT_ETW_MAX_PARAM_NAME_LENGTH 文字です。
Parameter8Value
[in]8 番目のパラメーターの値。 Parameter8Name が NULL または空の文字列の場合、Storport はこの値をゼロとしてログに記録します。
戻り値
StorPortNvmeMiniportEvent は、イベントが正常にログに記録された場合にSTOR_STATUS_SUCCESSを返します。 それ以外の場合は、次のような値が返されます。
リターン コード | 形容 |
---|---|
STOR_STATUS_NOT_IMPLEMENTED | この関数は、アクティブなオペレーティング システムでは実装されません。 |
STOR_STATUS_INVALID_PARAMETER | 1 つ以上のパラメーターが無効な場合、操作はこの戻り値で失敗します。 |
STOR_STATUS_UNSUCCESSFUL | その他の内部的な理由により、操作が失敗しました。 |
備考
ミニポートは、StorPortNvmeMiniportEvent を呼び出して、8 つの汎用 ETW パラメーターをログに記録できます。 ETW パラメーターは、8 つの名前と値のペアとして表されます。 パラメーターの名前が指定されていない場合 (パラメーターXName = NULL)、ルーチンは対応するパラメーター値を 0 に設定します。
StorPort ミニポート ドライバーから生成されたイベントは、EventChannel で指定されたチャネル記録されます。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 11 バージョン 24H2 |
ヘッダー | storport.h |