UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
UE::UnifiedError::FStaticErrorDetails Class Reference

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...

#include <UnifiedError.h>

+ Inheritance diagram for UE::UnifiedError::FStaticErrorDetails:

Public Member Functions

CORE_API FStaticErrorDetails (const FAnsiStringView InErrorName, const FAnsiStringView InModuleName, const FText &InErrorFormatString)
 
virtual ~FStaticErrorDetails ()=default
 
virtual CORE_API FAnsiString GetErrorCodeString (const FError &Error) const override
 GetErrorCodeString; Accessor for ErrorName.
Can be called directly on FStaticErrorDetails object.
See also: FError::GetErrorDetails.
 
virtual CORE_API FAnsiString GetModuleIdString (const FError &Error) const override
 GetModuleIdString; accessor for ModuleName. Can be called directly on FStaticErrorDetails object See also: FError::GetErrorDetails.
 
virtual CORE_API const FText GetErrorFormatString (const FError &Error) const final
 GetErrorFormatString; return the localized format text generated in DECLARE_ERROR macro.
 
virtual void SerializeToCb (FCbWriter &Writer, const FError &Error) const final
 
virtual FReturnedRefCountValue AddRef () const final
 
virtual uint32 Release () const final
 
virtual uint32 GetRefCount () const final
 
virtual bool ShouldInclude (const EDetailFilter Filter) const override
 
- Public Member Functions inherited from UE::UnifiedError::IErrorDetails
virtual ~IErrorDetails ()=default
 
virtual TRefCountPtr< const IErrorDetails > GetInnerErrorDetails () 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
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ FStaticErrorDetails()

UE::UnifiedError::FStaticErrorDetails::FStaticErrorDetails ( const FAnsiStringView  InErrorName,
const FAnsiStringView  InModuleName,
const FText &  InErrorFormatString 
)

◆ ~FStaticErrorDetails()

virtual UE::UnifiedError::FStaticErrorDetails::~FStaticErrorDetails ( )
virtualdefault

Member Function Documentation

◆ AddRef()

virtual FReturnedRefCountValue UE::UnifiedError::FStaticErrorDetails::AddRef ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ GetErrorCodeString()

FAnsiString UE::UnifiedError::FStaticErrorDetails::GetErrorCodeString ( const FError &  Error) const
overridevirtual

GetErrorCodeString; Accessor for ErrorName.
Can be called directly on FStaticErrorDetails object.
See also: FError::GetErrorDetails.

Returns

Implements UE::UnifiedError::FManditoryErrorDetails.

◆ GetErrorFormatString()

const FText UE::UnifiedError::FStaticErrorDetails::GetErrorFormatString ( const FError &  Error) const
finalvirtual

GetErrorFormatString; return the localized format text generated in DECLARE_ERROR macro.

Parameters
Error
Returns

Implements UE::UnifiedError::IErrorDetails.

◆ GetModuleIdString()

FAnsiString UE::UnifiedError::FStaticErrorDetails::GetModuleIdString ( const FError &  Error) const
overridevirtual

GetModuleIdString; accessor for ModuleName. Can be called directly on FStaticErrorDetails object See also: FError::GetErrorDetails.

Implements UE::UnifiedError::FManditoryErrorDetails.

◆ GetRefCount()

virtual uint32 UE::UnifiedError::FStaticErrorDetails::GetRefCount ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ Release()

virtual uint32 UE::UnifiedError::FStaticErrorDetails::Release ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ SerializeToCb()

virtual void UE::UnifiedError::FStaticErrorDetails::SerializeToCb ( FCbWriter &  Writer,
const FError &  Error 
) const
inlinefinalvirtual

Implements UE::UnifiedError::IErrorDetails.

◆ ShouldInclude()

virtual bool UE::UnifiedError::FStaticErrorDetails::ShouldInclude ( const EDetailFilter  Filter) const
inlineoverridevirtual

Reimplemented from UE::UnifiedError::IErrorDetails.

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