StopTracingSession

C++ Build Insights SDK 与 Visual Studio 2017 及更高版本兼容。 若要查看这些版本对应的文档,请将本文的 Visual Studio“版本”选择器控件设置为 Visual Studio 2017 或更高版本。 它位于此页面上目录表的顶部。

StopTracingSession 函数用于停止正在进行的跟踪会话并生成原始跟踪文件。 可以将原始跟踪文件传递给 AnalyzeAnalyzeA,以及 AnalyzeW 函数来启动分析会话。 可以将原始跟踪文件传递给 RelogRelogARelogW 函数来启动重新记录会话。

调用方必须具有管理员权限才能使用 StopTracingSession

语法

inline RESULT_CODE StopTracingSession(
    const char*                 sessionName,
    const char*                 outputLogFile,
    TRACING_SESSION_STATISTICS* statistics);

inline RESULT_CODE StopTracingSession(
    const wchar_t*              sessionName,
    const wchar_t*              outputLogFile,
    TRACING_SESSION_STATISTICS* statistics);

参数

sessionName
要停止的跟踪会话的名称。 使用与 StartTracingSessionStartTracingSessionAStartTracingSessionW 相同的会话名称。

输出日志文件
用于保存原始跟踪的最终输出日志文件的完整路径。

statistics
指向 TRACING_SESSION_STATISTICS 对象的指针。 StopTracingSession 在返回之前写入此对象中的跟踪集合统计信息。

返回值

RESULT_CODE 枚举中的结果代码。