FIoStatus Class Reference

#include <IoStatus.h>

Public Member Functions
CORE_API	FIoStatus ()
CORE_API	~FIoStatus ()
CORE_API	FIoStatus (EIoErrorCode ErrorCode, const FStringView &ErrorMessage)
CORE_API	FIoStatus (EIoErrorCode ErrorCode, uint32 SystemErrorCode, const FStringView &ErrorMessage)
CORE_API	FIoStatus (EIoErrorCode ErrorCode, uint32 SystemErrorCode)
CORE_API	FIoStatus (EIoErrorCode ErrorCode)
CORE_API FIoStatus &	operator= (const FIoStatus &Other)
CORE_API FIoStatus &	operator= (const EIoErrorCode ErrorCode)
CORE_API bool	operator== (const FIoStatus &Other) const
bool	operator!= (const FIoStatus &Other) const
bool	IsOk () const
bool	IsCompleted () const
EIoErrorCode	GetErrorCode () const
uint32	GetSystemErrorCode () const
const TCHAR *	GetErrorMessage () const
CORE_API FString	ToString () const

Static Public Attributes
static CORE_API const FIoStatus	Ok { EIoErrorCode::Ok, TEXT("OK") }
static CORE_API const FIoStatus	Unknown { EIoErrorCode::Unknown, TEXT("Unknown Status") }
static CORE_API const FIoStatus	Invalid { EIoErrorCode::InvalidCode, TEXT("Invalid Code") }

Friends
class	FIoStatusBuilder
CORE_API friend void	SerializeForLog (FCbWriter &Writer, const FIoStatus &Value)

Detailed Description

I/O status with error code, error message and an optional system error code.

Constructor & Destructor Documentation

FIoStatus() [1/5]

FIoStatus::FIoStatus

(

)

~FIoStatus()

FIoStatus::~FIoStatus

(

)

FIoStatus() [2/5]

FIoStatus::FIoStatus	(	EIoErrorCode	ErrorCode,
		const FStringView &	ErrorMessage
	)

FIoStatus() [3/5]

FIoStatus::FIoStatus	(	EIoErrorCode	ErrorCode,
		uint32	SystemErrorCode,
		const FStringView &	ErrorMessage
	)

FIoStatus() [4/5]

FIoStatus::FIoStatus	(	EIoErrorCode	ErrorCode,
		uint32	SystemErrorCode
	)

FIoStatus() [5/5]

FIoStatus::FIoStatus

(

EIoErrorCode

ErrorCode

)

Member Function Documentation

GetErrorCode()

EIoErrorCode FIoStatus::GetErrorCode ( ) const

inline

GetErrorMessage()

const TCHAR * FIoStatus::GetErrorMessage ( ) const

inline

GetSystemErrorCode()

uint32 FIoStatus::GetSystemErrorCode ( ) const

inline

IsCompleted()

bool FIoStatus::IsCompleted ( ) const

inline

IsOk()

bool FIoStatus::IsOk ( ) const

inline

operator!=()

bool FIoStatus::operator!= ( const FIoStatus &  Other ) const

inline

operator=() [1/2]

FIoStatus & FIoStatus::operator=

(

const EIoErrorCode

ErrorCode

)

operator=() [2/2]

FIoStatus & FIoStatus::operator=

(

const FIoStatus &

Other

)

operator==()

bool FIoStatus::operator==

(

const FIoStatus &

Other

)

const

ToString()

FString FIoStatus::ToString

(

)

const

Friends And Related Symbol Documentation

FIoStatusBuilder

friend class FIoStatusBuilder

friend

SerializeForLog

CORE_API friend void SerializeForLog ( FCbWriter &  Writer, const FIoStatus &  Value  )

friend

Member Data Documentation

Invalid

const FIoStatus FIoStatus::Invalid { EIoErrorCode::InvalidCode, TEXT("Invalid Code") }

static

Ok

const FIoStatus FIoStatus::Ok { EIoErrorCode::Ok, TEXT("OK") }

static

Unknown

const FIoStatus FIoStatus::Unknown { EIoErrorCode::Unknown, TEXT("Unknown Status") }

static

---

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

• Engine/Source/Runtime/Core/Public/IO/IoStatus.h
• Engine/Source/Runtime/Core/Private/IO/IoStatus.cpp