FWindowsConsoleOutputDevice Class Reference

#include <WindowsConsoleOutputDevice.h>

Inheritance diagram for FWindowsConsoleOutputDevice:

Public Member Functions
APPLICATIONCORE_API	FWindowsConsoleOutputDevice ()
APPLICATIONCORE_API	~FWindowsConsoleOutputDevice ()
virtual APPLICATIONCORE_API void	Show (bool ShowWindow)
virtual APPLICATIONCORE_API bool	IsShown ()
virtual APPLICATIONCORE_API bool	IsAttached ()
virtual APPLICATIONCORE_API bool	CanBeUsedOnAnyThread () const override
virtual APPLICATIONCORE_API bool	CanBeUsedOnPanicThread () const override
virtual APPLICATIONCORE_API void	Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const class FName &Category, const double Time) override
virtual APPLICATIONCORE_API void	Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const class FName &Category) override
APPLICATIONCORE_API void	SetColor (const TCHAR *Color)
Public Member Functions inherited from FOutputDeviceConsole
void	SetIniFilename (const TCHAR *InFilename)
Public Member Functions inherited from FOutputDevice
CORE_API	FOutputDevice ()
CORE_API	FOutputDevice (FOutputDevice &&)
CORE_API	FOutputDevice (const FOutputDevice &)
CORE_API FOutputDevice &	operator= (FOutputDevice &&)
CORE_API FOutputDevice &	operator= (const FOutputDevice &)
virtual CORE_API	~FOutputDevice ()
virtual void	Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
virtual void	Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
virtual CORE_API void	SerializeRecord (const UE::FLogRecord &Record)
virtual void	Flush ()
virtual void	TearDown ()
void	SetSuppressEventTag (bool bInSuppressEventTag)
UE_FORCEINLINE_HINT bool	GetSuppressEventTag () const
void	SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
UE_FORCEINLINE_HINT bool	GetAutoEmitLineTerminator () const
virtual void	Dump (class FArchive &Ar)
virtual bool	IsMemoryOnly () const
virtual bool	CanBeUsedOnMultipleThreads () const
CORE_API void	Log (const TCHAR *S)
CORE_API void	Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
CORE_API void	Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
CORE_API void	Log (const FString &S)
CORE_API void	Log (const FText &S)
CORE_API void	Log (ELogVerbosity::Type Verbosity, const FString &S)
CORE_API void	Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
template<typename FmtType >
void	Logf (const FmtType &Fmt)
template<typename FmtType , typename... Types>
void	Logf (const FmtType &Fmt, Types... Args)
template<typename FmtType , typename... Types>
void	Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
template<typename FmtType , typename... Types>
void	CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)

Additional Inherited Members
Protected Attributes inherited from FOutputDeviceConsole
FString	IniFilename
Protected Attributes inherited from FOutputDevice
bool	bSuppressEventTag
bool	bAutoEmitLineTerminator

Detailed Description

Windows implementation of console log window, utilizing the Win32 console API

Constructor & Destructor Documentation

FWindowsConsoleOutputDevice()

FWindowsConsoleOutputDevice::FWindowsConsoleOutputDevice

(

)

Constructor, setting console control handler.

~FWindowsConsoleOutputDevice()

FWindowsConsoleOutputDevice::~FWindowsConsoleOutputDevice

(

)

Member Function Documentation

CanBeUsedOnAnyThread()

bool FWindowsConsoleOutputDevice::CanBeUsedOnAnyThread ( ) const

overridevirtual

Returns

whether this output device can be used on any thread.

Reimplemented from FOutputDevice.

CanBeUsedOnPanicThread()

bool FWindowsConsoleOutputDevice::CanBeUsedOnPanicThread ( ) const

overridevirtual

Returns

whether this output device can be used after a panic (crash or fatal error) has been flagged.

Note

The return value is cached by AddOutputDevice because calling this during a panic may fail.

Reimplemented from FOutputDevice.

IsAttached()

bool FWindowsConsoleOutputDevice::IsAttached ( )

virtual

Returns whether the application is already attached to a console window.

Returns

true if console is attached, false otherwise.

Reimplemented from FOutputDeviceConsole.

IsShown()

bool FWindowsConsoleOutputDevice::IsShown ( )

virtual

Returns whether console is currently shown or not

Returns

true if console is shown, false otherwise

Implements FOutputDeviceConsole.

Serialize() [1/2]

void FWindowsConsoleOutputDevice::Serialize ( const TCHAR *  Data, ELogVerbosity::Type  Verbosity, const class FName &  Category  )

overridevirtual

Serialize() [2/2]

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

overridevirtual

Displays text on the console and scrolls if necessary.

Parameters

Data	Text to display
Event	Event type, used for filtering/ suppression

SetColor()

void FWindowsConsoleOutputDevice::SetColor

(

const TCHAR *

Color

)

Show()

void FWindowsConsoleOutputDevice::Show ( bool  ShowWindow )

virtual

Shows or hides the console window.

Parameters

ShowWindow

Whether to show (true) or hide (false) the console window.

Implements FOutputDeviceConsole.

---

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

• Engine/Source/Runtime/ApplicationCore/Public/Windows/WindowsConsoleOutputDevice.h
• Engine/Source/Runtime/ApplicationCore/Private/Windows/WindowsConsoleOutputDevice.cpp