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 參數都會將一個字段新增至事件。

此值可以是任何 Windows sockaddr 類型，例如 SOCKADDR、 SOCKADDR_IN、 SOCKADDR_IN6、 SOCKADDR_STORAGE等。事件會記錄原始二進位數據和數據大小。 事件譯碼器會使用 sa_family 欄位來判斷套接字地址的實際類型。

注意

並非所有譯碼器都支援所有 sockaddr 系列類型。 如果遇到不支援的 sockaddr，譯碼器可能會將字段譯碼為原始二進位數據，而不是將它格式化為位址。

規格需求

需求	值
最低支援的用戶端	Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器	Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台	Windows
標頭	traceloggingprovider.h

另請參閱

TraceLoggingWrite

TraceLogging 包裝函式宏