UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::UnifiedError::FManditoryErrorDetails Class Referenceabstract

FManditoryErrorDetails every FError needs to be initialized with one of these, it contains core information about the error including errorcodestring and module name. More...

#include <UnifiedError.h>

+ Inheritance diagram for UE::UnifiedError::FManditoryErrorDetails:

Public Member Functions

virtual FAnsiString GetErrorCodeString (const FError &Error) const =0
 
virtual FAnsiString GetModuleIdString (const FError &Error) const =0
 
- Public Member Functions inherited from UE::UnifiedError::IErrorDetails
virtual ~IErrorDetails ()=default
 
virtual const FText GetErrorFormatString (const FError &Error) const =0
 GetErrorFormatString; specifies the default error format string to be used when generating FError::GetErrorMessage. The format string can specify any property exposed by any encapsulated IErrorDetails::GetErrorProperties. Example: GetErrorProperties adds Name:"ModuleId" Value:10. GetErrorFormatString returns "Module id was {ModuleId}". Result "Module id was 10".
 
virtual TRefCountPtr< const IErrorDetailsGetInnerErrorDetails () const
 GetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.
 
virtual void SetInnerErrorDetails (TRefCountPtr< const IErrorDetails > ErrorDetails)
 SetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.
 
virtual uint64 GetErrorDetailsTypeId () const =0
 GetErrorDetialsTypeId; Simple type information for error details, generated using hash of details name See also: define FERROR_DETAILS.
 
virtual const FAnsiStringView GetErrorDetailsTypeName () const =0
 
virtual const FAnsiStringView GetErrorDetailsTypeNameForLog () const =0
 
virtual void SerializeToCb (FCbWriter &Writer, const FError &Error) const =0
 
virtual bool ShouldInclude (const EDetailFilter DetailFilter) const
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 
virtual FReturnedRefCountValue AddRef () const =0
 
virtual uint32 Release () const =0
 
virtual uint32 GetRefCount () const =0
 

Detailed Description

FManditoryErrorDetails every FError needs to be initialized with one of these, it contains core information about the error including errorcodestring and module name.

Member Function Documentation

◆ GetErrorCodeString()

virtual FAnsiString UE::UnifiedError::FManditoryErrorDetails::GetErrorCodeString ( const FError Error) const
pure virtual

◆ GetModuleIdString()

virtual FAnsiString UE::UnifiedError::FManditoryErrorDetails::GetModuleIdString ( const FError Error) const
pure virtual

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