Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FOutputDeviceHelper Struct Reference

#include <OutputDeviceHelper.h>

Static Public Member Functions

static void AppendFormatLogLine (FWideStringBuilderBase &Output, ELogVerbosity::Type Verbosity, const FName &Category, const TCHAR *Message=nullptr, ELogTimes::Type LogTime=ELogTimes::None, double Time=-1.0, int32 *OutCategoryIndex=nullptr)
 
static void AppendFormatLogLine (FUtf8StringBuilderBase &Output, ELogVerbosity::Type Verbosity, const FName &Category, const TCHAR *Message=nullptr, ELogTimes::Type LogTime=ELogTimes::None, double Time=-1.0, int32 *OutCategoryIndex=nullptr)
 
static FString FormatLogLine (ELogVerbosity::Type Verbosity, const FName &Category, const TCHAR *Message=nullptr, ELogTimes::Type LogTime=ELogTimes::None, double Time=-1.0, int32 *OutCategoryIndex=nullptr)
 
static void FormatCastAndSerializeLine (FArchive &Output, const TCHAR *Message, ELogVerbosity::Type Verbosity, const FName &Category, double Time, bool bSuppressEventTag, bool bAutoEmitLineTerminator)
 

Detailed Description

Helper functions used by FOutputDevice derived classes

Definition at line 19 of file OutputDeviceHelper.h.

Member Function Documentation

◆ AppendFormatLogLine() [1/2]

static void FOutputDeviceHelper::AppendFormatLogLine ( FUtf8StringBuilderBase & Output,
ELogVerbosity::Type Verbosity,
const FName & Category,
const TCHAR * Message = nullptr,
ELogTimes::Type LogTime = ELogTimes::None,
double Time = -1.0,
int32 * OutCategoryIndex = nullptr )
static

◆ AppendFormatLogLine() [2/2]

static void FOutputDeviceHelper::AppendFormatLogLine ( FWideStringBuilderBase & Output,
ELogVerbosity::Type Verbosity,
const FName & Category,
const TCHAR * Message = nullptr,
ELogTimes::Type LogTime = ELogTimes::None,
double Time = -1.0,
int32 * OutCategoryIndex = nullptr )
static

Append a formatted log line to the string builder.

◆ FormatCastAndSerializeLine()

static void FOutputDeviceHelper::FormatCastAndSerializeLine ( FArchive & Output,
const TCHAR * Message,
ELogVerbosity::Type Verbosity,
const FName & Category,
double Time,
bool bSuppressEventTag,
bool bAutoEmitLineTerminator )
static

Formats, casts to ANSI char and serializes a message to archive. Optimized for small number of allocations and Serialize calls

Parameters
OutputOutput archive
MessageLog message
VerbosityMessage verbosity
CategoryMessage category
TimeMessage time
bSuppressEventTagTrue if the message date/time prefix should be suppressed
bAutoEmitLineTerminatorTrue if the message should be automatically appended with a line terminator

◆ FormatLogLine()

static FString FOutputDeviceHelper::FormatLogLine ( ELogVerbosity::Type Verbosity,
const FName & Category,
const TCHAR * Message = nullptr,
ELogTimes::Type LogTime = ELogTimes::None,
double Time = -1.0,
int32 * OutCategoryIndex = nullptr )
static

Formats a log line with date, time, category and verbosity prefix

Parameters
VerbosityMessage verbosity
CategoryMessage category
MessageOptional message text. If nullptr, only the date/time/category/verbosity prefix will be returned
LogTimeTime format
TimeTime in seconds
OutCategoryIndex(if non-null) The index of the category within the return string is written here, or INDEX_NONE if the category is suppressed
Returns
Formatted log line

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