Edit

StopTracingSession

  • Article

The C++ Build Insights SDK is compatible with Visual Studio 2017 and later. To see the documentation for these versions, set the Visual Studio Version selector control for this article to Visual Studio 2017 or later. It's found at the top of the table of contents on this page.

The StopTracingSession function stops an ongoing tracing session and produces a raw trace file. You can pass raw trace files to the Analyze, AnalzeA, and AnalyzeW functions to start an analysis session. You can pass raw trace files to the Relog, RelogA, and RelogW functions to start a relogging session.

The caller must have administrator permissions to use StopTracingSession.

Syntax

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);

Parameters

sessionName
The name of the tracing session to stop. Use the same session name as used for StartTracingSession, StartTracingSessionA, or StartTracingSessionW.

outputLogFile
Full path of the final output log file to save the raw trace.

statistics
Pointer to a TRACING_SESSION_STATISTICS object. StopTracingSession writes trace collection statistics in this object before returning.

Return Value

A result code from the RESULT_CODE enum.