UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::UnifiedError Namespace Reference

Namespaces

namespace  ErrorRegistry
 
namespace  IoStore
 
namespace  IoStoreOnDemand
 
namespace  StreamableManager
 

Classes

class  FAppendFormatStringDetails
 
class  FDynamicErrorDetails
 FDynamicErrorDetails; base implementation of inner error details, for use by derived classes to reduce unnessisary reimplementation. More...
 
class  FError
 
class  FErrorDetailsRegistry
 
class  FManditoryErrorDetails
 FManditoryErrorDetails every FError needs to be initialized with one of these, it contains core information about the error including errorcodestring and module name. More...
 
class  FRefCountedErrorDetails
 FRefCountedErrorDetails; base implementation of refcounting for IErrorDetails, this is used for heap allocated IErrorDetails implementations. More...
 
class  FStaticErrorDetails
 FStaticErrorDetails; static error details and members are statically allocated Every error which uses DEFINE_ERROR will have FStaticErrorDetails generated for it Can not rely on it to be available for every error as some Error conversion functions will not use pregenerated errors or error codesF Use FError::GetErrorDetails to discover FStaticErrorDetails. More...
 
class  IErrorDetails
 
class  TErrorDetails
 

Enumerations

enum class  EDetailFilter : uint8 {
  IncludeInSerialize = 1 << 0 , IncludeInAnalytics = 1 << 1 , IncludeInContextLogMessage = 1 << 2 , IncludeInLogMessage = 1 << 3 ,
  Default = IncludeInSerialize | IncludeInContextLogMessage , None = 0x00 , All = 0xff
}
 

Functions

bool IsCancellationError (const FError &Error)
 
void SerializeForLog (FCbWriter &Writer, const FError &Error)
 
 ENUM_CLASS_FLAGS (EDetailFilter)
 
CORE_API void SerializeForLog (FCbWriter &Writer, const class FError &Error)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FStringView &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FUtf8StringView &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const int32 &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const uint32 &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const int64 &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const uint64 &Value)
 
void SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FText &Value)
 

Enumeration Type Documentation

◆ EDetailFilter

Enumerator
IncludeInSerialize 
IncludeInAnalytics 
IncludeInContextLogMessage 
IncludeInLogMessage 
Default 
None 
All 

Function Documentation

◆ ENUM_CLASS_FLAGS()

UE::UnifiedError::ENUM_CLASS_FLAGS ( EDetailFilter  )

◆ IsCancellationError()

CORE_API bool UE::UnifiedError::IsCancellationError ( const FError Error)

◆ SerializeBasicToCb() [1/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const FStringView Value 
)
inline

◆ SerializeBasicToCb() [2/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const FText Value 
)
inline

◆ SerializeBasicToCb() [3/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const FUtf8StringView Value 
)
inline

◆ SerializeBasicToCb() [4/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const int32 Value 
)
inline

◆ SerializeBasicToCb() [5/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const int64 Value 
)
inline

◆ SerializeBasicToCb() [6/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const uint32 Value 
)
inline

◆ SerializeBasicToCb() [7/7]

void UE::UnifiedError::SerializeBasicToCb ( FCbWriter Writer,
const FUtf8StringView PropertyName,
const uint64 Value 
)
inline

◆ SerializeForLog() [1/2]

CORE_API void UE::UnifiedError::SerializeForLog ( FCbWriter Writer,
const class FError Error 
)

◆ SerializeForLog() [2/2]

void UE::UnifiedError::SerializeForLog ( FCbWriter Writer,
const FError Error 
)