TraceLoggingSocketAddress マクロ (traceloggingprovider.h)

イベントにソケット アドレスを持つフィールドを追加する TraceLogging ラッパー マクロ。

構文

void TraceLoggingSocketAddress(
  [in]            pValue,
  [in]            cbValue,
  [in, optional]  __VA_ARGS__
);

パラメーター

[in] pValue

sockaddr 構造体へのポインター。

[in] cbValue

pValue パラメーターが指す値のサイズ (バイト単位)。

注意

sockaddr フィールドに必要なデータの量は、アドレスの種類によって異なります。 データが共用体変数に格納されている場合は、データの切り捨てを回避するために、cbValue パラメーターを正しい共用体メンバーのサイズ (または共用体のサイズ) に設定してください。

[in, optional] __VA_ARGS__

フィールド定義の省略可能な 名前、 説明、 タグ パラメーター。

TraceLoggingSocketAddress は、2、3、4、または 5 個のパラメーターで指定できます。 パラメーターが指定されていない場合は、既定値が使用されます。 たとえば、TraceLoggingSocketAddress(&x.sockAddr, sizeof(x.sockAddr)) は、TraceLoggingSocketAddress(&x.sockAddr, sizeof(x.sockAddr), "&x.sockAddr", "", 0) と同じです。

• [in, optional] name

  イベント フィールドに使用する名前。 指定する場合、name パラメーターは文字列リテラル (変数ではない) であり、'\0' 文字を含めてはなりません。 指定しない場合、イベント フィールド名は pValue に基づいています。

• [in, optional] description

  イベント フィールドの値の説明。 指定した場合、description パラメーターは文字列リテラルである必要があり、 PDB に含まれます。

• [in, optional] tags

  コンパイル時の定数整数値。 値の下位 28 ビットは、フィールドのメタデータに含まれます。 この値のセマンティクスは、イベント コンシューマーによって定義されます。 イベント処理中に、この値は [EVENT_PROPERTY_INFO タグ] フィールドから取得できます。

戻り値

なし

解説

TraceLoggingSocketAddress(pValue, cbValue, ...)は、TraceLoggingWrite マクロの呼び出しのパラメーターとして使用できます。 各 TraceLoggingSocketAddress パラメーターは、イベントに 1 つのフィールドを追加します。

値には、SOCKADDR、SOCKADDR_IN、SOCKADDR_IN6、SOCKADDR_STORAGEなど、任意の Windows sockaddr 型を指定できます。このイベントでは、生のバイナリ データとデータ サイズが記録されます。 イベント デコーダーは、 フィールドを sa_family 使用してソケット アドレスの実際の型を決定します。

注意

すべてのデコーダーですべての sockaddr ファミリの種類がサポートされるわけではありません。 サポートされていない sockaddr が検出された場合、デコーダーはフィールドをアドレスとして書式設定するのではなく、生のバイナリ データとしてデコードする可能性があります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	traceloggingprovider.h

こちらもご覧ください

TraceLoggingWrite

トレース ログ ラッパー マクロ