FStringTrace Class Reference

#include <StringsTrace.h>

Static Public Member Functions
static UE_API UE::Trace::FEventRef32	GetNameRef (const FName &Name)
static UE_API UE::Trace::FEventRef64	GetStaticStringRef (const TCHAR *String)
static UE_API UE::Trace::FEventRef64	GetStaticStringRef (const ANSICHAR *String)
static void	OnConnection ()

Detailed Description

Utility class to trace deduplicated strings, FNames and static strings. Each function returning a reference that can be used when tracing events.

A event defined as:

UE_TRACE_EVENT_BEGIN(Asset)
    UE_TRACE_EVENT_REFERENCE_FIELD(Strings, FName, Name)
    UE_TRACE_EVENT_REFERENCE_FIELD(Strings, StaticString, File)
UE_TRACE_EVENT_END()
 
Can be emitted with:
auto NameRef = FStringTrace::GetNameRef(Object->GetFName());
auto FileRef = FStringTrace::GetStaticStringRef(__FILE__);
UE_TRACE_LOG(Asset)
    << Asset.Name(NameRef)
    << Asset.File(FileRef);

Member Function Documentation

GetNameRef()

UE_FORCEINLINE_HINT UE::Trace::FEventRef32 FStringTrace::GetNameRef ( const FName &  Name )

static

Gets the trace id of a FName.

Parameters

Name	Name to trace.

Returns

Id that can be used to reference the name.

GetStaticStringRef() [1/2]

UE_FORCEINLINE_HINT UE::Trace::FEventRef64 FStringTrace::GetStaticStringRef ( const ANSICHAR *  String )

static

Gets the trace id of a static string. Will use the address of the string for deduplication, so it is important to only pass static strings to this function.

Parameters

String

Static string

Returns

Id that can be used to reference the string.

GetStaticStringRef() [2/2]

UE_FORCEINLINE_HINT UE::Trace::FEventRef64 FStringTrace::GetStaticStringRef ( const TCHAR *  String )

static

Gets the trace id of a static string. Will use the address of the string for deduplication, so it is important to only pass static strings to this function.

Parameters

String

Static string

Returns

Id that can be used to reference the string.

OnConnection()

UE_FORCEINLINE_HINT void FStringTrace::OnConnection ( )

static

On a new connection callback.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/ProfilingDebugging/StringsTrace.h