FTraceAuxiliary::Start

Start tracing to a target (network connection or file) with an active set of channels.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/ProfilingDebugging/TraceAuxiliary.h

Include

#include "ProfilingDebugging/TraceAuxiliary.h"

Source

/Engine/Source/Runtime/Core/Private/ProfilingDebugging/TraceAuxiliary.cpp

Syntax

static bool Start
(
    EConnectionType Type,
    const TCHAR * Target,
    const TCHAR * Channels,
    Options * Options,
    const FLogCategoryAlias & LogCategory
)

Remarks

Start tracing to a target (network connection or file) with an active set of channels. If a connection is already active this call does nothing.

Returns

True when successfully starting the trace, false if the data connection could not be made.

Parameters

Parameter

Description

Type

Type of connection

Target

String to use for connection. See /ref EConnectionType for details.

Channels

Comma separated list of channels to enable. If the pointer is null the default channels will be active.

Options

Optional additional tracing options.

LogCategory

Log channel to output messages to. Default set to 'Core'.