Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FOutputDeviceFile

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

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
	FOutputDeviceFile ( const TCHAR* InFilename, bool bDisableBackup, bool bAppendIfExists, bool bCreateWriterLazily, TFunction< void*)>... )	Constructor, initializing member variables. Constructor, initializing member variables.

Name

Description

FOutputDeviceFile

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

Constructor, initializing member variables.

Destructors

	Name	Description
	~FOutputDeviceFile()	Destructor to perform teardown

Functions

	Name	Description
void	CreateBackupCopy ( const TCHAR* Filename )	Creates a backup copy of a log file if it already exists
const TCHAR ...	GetFilename()	Returns the filename associated with this output device
void	IncludeCategory ( const FName& InCategoryName )	Add a category name to our inclusion filter.
bool	IsBackupCopy ( const TCHAR* Filename )	Checks if the filename represents a backup copy of a log file
bool	IsOpened()
void	Serialize ( const TCHAR* Data, ELogVerbosity::Type Verbosity, const FName& Category )
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.
void	SetFilename ( const TCHAR* InFilename )	Sets the filename that the output device writes to.

Overridden from FOutputDevice

	Name	Description
bool	CanBeUsedOnAnyThread()
void	Flush()	Flush the write cache so the file isn't truncated in case we crash right after calling this function.
void	TearDown()	Closes output device and cleans up.

Classes

	Name	Description
	FCategoryInclusionInternal

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss