FOutputDeviceFile

File output device ( Only works if ALLOW_LOG_FILE && !NO_LOGGING is true, otherwise Serialize does nothing).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FOutputDevice

FOutputDeviceFile

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/OutputDeviceFile.h

Include

#include "Misc/OutputDeviceFile.h"

Syntax

class FOutputDeviceFile : public FOutputDevice

Remarks

File output device (

Only works if ALLOW_LOG_FILE && !NO_LOGGING is true, otherwise Serialize does nothing).

Constructors

Name Description

Public function

FOutputDeviceFile

(
    const TCHAR* InFilename,
    bool bDisableBackup,
    bool bAppendIfExists,
    bool bCreateWriterLazily,
    TFunction< void*)>...
)

Constructor, initializing member variables.

Constructor, initializing member variables.

Destructors

Name Description

Public function

~FOutputDeviceFile()

Destructor to perform teardown

Functions

Name Description

Public function Static

void

 

CreateBackupCopy

(
    const TCHAR* Filename
)

Creates a backup copy of a log file if it already exists

Public function Const

const TCHAR ...

 

GetFilename()

Returns the filename associated with this output device

Public function

void

 

IncludeCategory

(
    const FName& InCategoryName
)

Add a category name to our inclusion filter.

Public function Static

bool

 

IsBackupCopy

(
    const TCHAR* Filename
)

Checks if the filename represents a backup copy of a log file

Public function Const

bool

 

IsOpened()

Public function Virtual

void

 

Serialize

(
    const TCHAR* Data,
    ELogVerbosity::Type Verbosity,
    const FName& Category
)

Public function Virtual

void

 

Serialize

(
    const TCHAR* Data,
    ELogVerbosity::Type Verbosity,
    const FName& Category,
    const double Time
)

Serializes the passed in data unless the current event is suppressed.

Public function

void

 

SetFilename

(
    const TCHAR* InFilename
)

Sets the filename that the output device writes to.

Overridden from FOutputDevice

Name Description

Public function Virtual Const

bool

 

CanBeUsedOnAnyThread()

Public function Virtual

void

 

Flush()

Flush the write cache so the file isn't truncated in case we crash right after calling this function.

Public function Virtual

void

 

TearDown()

Closes output device and cleans up.

Classes

Name

Description

Public struct

FCategoryInclusionInternal