FlushTraceA 函式 (evntrace.h)

FlushTrace 函式會導致事件追蹤會話立即傳遞指定會話的緩衝事件。 根據預設，事件追蹤會話會在緩衝區已滿、工作階段的 FlushTimer 到期或會話關閉時傳遞事件。

此函式已過時。 ControlTrace 函式會取代此函式。

語法

ULONG WMIAPI FlushTraceA(
  [in]      TRACEHANDLE             TraceHandle,
  [in]      LPCSTR                  InstanceName,
  [in, out] PEVENT_TRACE_PROPERTIES Properties
);

參數

[in] TraceHandle

要排清的事件追蹤會話句柄，或 0。 如果 InstanceName 為 NULL，您必須指定非零 TraceHandle。 只有在 InstanceName 為 NULL 時，才會使用此參數。 StartTrace 會傳回句柄。

[in] InstanceName

要排清的事件追蹤會話名稱，或 為 NULL。 如果 TraceHandle 為 0，您必須指定 InstanceName。

若要指定NT核心記錄器會話，請將 InstanceName 設定為 KERNEL_LOGGER_NAME。

[in, out] Properties

初始化 EVENT_TRACE_PROPERTIES 結構的指標。

如果您使用新初始化的結構，則只需要設定結構的 Wnode.BufferSize、 Wnode.Guid、 LoggerNameOffset 和 LogFileNameOffset 成員。 您可以使用最大會話名稱 (1024 個字元) 和記錄檔名稱上限 (1024 個字元，) 長度來計算緩衝區大小和不已知位移。

在輸出時，結構會接收事件追蹤會話的屬性設定和會話統計數據，以反映排清之後的會話狀態。

傳回值

如果函式成功，傳回值會ERROR_SUCCESS。

如果函式失敗，傳回值就是其中一個 系統錯誤碼。 下表包含一些常見的錯誤及其原因。

• ERROR_INVALID_PARAMETER

  以下其中一項為正確：

  • 屬性 為 NULL。
  • InstanceName 和 TraceHandle 都是 NULL。
  • InstanceName 為 NULL ，且 TraceHandle 不是有效的句柄。

• ERROR_BAD_LENGTH

  以下其中一項為正確：

  • Properties 的 Wnode.BufferSize 成員指定了不正確的大小。
  • 如果) ，屬性沒有足夠的空間配置來保存會話名稱和記錄檔名稱的複本 (。

• ERROR_ACCESS_DENIED

  只有具有系統管理許可權的使用者、效能記錄使用者群組中的使用者，以及以LocalSystem、LocalService、NetworkService執行的服務可以控制事件追蹤會話。 若要授與受限制的使用者控制追蹤會話的能力，請將它們新增至效能記錄使用者群組。

  Windows XP 和 Windows 2000： 任何人都可以控制追蹤會話。

備註

事件追蹤控制器會呼叫此函式。

此函式已過時。 請改用 ControlTrace 搭配 ControlCode 設定為 EVENT_TRACE_CONTROL_FLUSH。

此函式可以與記憶體內部會話搭配使用， (以 EVENT_TRACE_BUFFERING_MODE 旗標開頭的會話) ，以將數據從追蹤寫入檔案。

您通常不需要排清以檔案為基礎的或即時會話，因為 ETW 會在緩衝區已滿時自動排清緩衝區 (亦即當它沒有空間供下一個事件) 、追蹤會話的 FlushTimer 到期或追蹤會話關閉時。

請勿從 DllMain (呼叫 FlushTrace ，可能會導致死結) 。

注意

evntrace.h 標頭會將 FlushTrace 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器	Windows Server 2003 [傳統型應用程式 |UWP 應用程式]
目標平台	Windows
標頭	evntrace.h
程式庫	Advapi32.lib
Dll	Advapi32.dll

另請參閱

ControlTrace