UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::UnifiedError::IoStore::FIoStoreErrorDetails Class Reference
+ Inheritance diagram for UE::UnifiedError::IoStore::FIoStoreErrorDetails:

Public Member Functions

 FIoStoreErrorDetails (const FStringView &InErrorMessage)
 
virtual FReturnedRefCountValue AddRef () const final
 
virtual uint32 Release () const final
 
virtual uint32 GetRefCount () const final
 
const FUtf8StringGetErrorName (const FError &Error) const
 
FAnsiString GetErrorCodeString (const UE::UnifiedError::FError &Error) const override
 
FAnsiString GetModuleIdString (const UE::UnifiedError::FError &Error) const override
 
virtual const FText GetErrorFormatString (const FError &Error) const final override
 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 void SerializeToCb (FCbWriter &Writer, const FError &Error) const override
 
virtual const FAnsiStringView GetErrorDetailsTypeName () const override
 
virtual const FAnsiStringView GetErrorDetailsTypeNameForLog () const override
 
- Public Member Functions inherited from UE::UnifiedError::IErrorDetails
virtual ~IErrorDetails ()=default
 
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 bool ShouldInclude (const EDetailFilter DetailFilter) const
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 
- Public Member Functions inherited from FRefCountBase
 FRefCountBase ()=default
 
virtual ~FRefCountBase ()=default
 
 FRefCountBase (const FRefCountBase &Rhs)=delete
 
FRefCountBaseoperator= (const FRefCountBase &Rhs)=delete
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 

Constructor & Destructor Documentation

◆ FIoStoreErrorDetails()

UE::UnifiedError::IoStore::FIoStoreErrorDetails::FIoStoreErrorDetails ( const FStringView InErrorMessage)
inline

Member Function Documentation

◆ AddRef()

virtual FReturnedRefCountValue UE::UnifiedError::IoStore::FIoStoreErrorDetails::AddRef ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ GetErrorCodeString()

FAnsiString UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetErrorCodeString ( const UE::UnifiedError::FError Error) const
inlineoverridevirtual

◆ GetErrorDetailsTypeName()

virtual const FAnsiStringView UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetErrorDetailsTypeName ( ) const
inlineoverridevirtual

◆ GetErrorDetailsTypeNameForLog()

virtual const FAnsiStringView UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetErrorDetailsTypeNameForLog ( ) const
inlineoverridevirtual

◆ GetErrorFormatString()

virtual const FText UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetErrorFormatString ( const FError Error) const
inlinefinaloverridevirtual

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

Parameters
Error
Returns

Implements UE::UnifiedError::IErrorDetails.

◆ GetErrorName()

const FUtf8String & UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetErrorName ( const FError Error) const
inline

◆ GetModuleIdString()

FAnsiString UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetModuleIdString ( const UE::UnifiedError::FError Error) const
inlineoverridevirtual

◆ GetRefCount()

virtual uint32 UE::UnifiedError::IoStore::FIoStoreErrorDetails::GetRefCount ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ Release()

virtual uint32 UE::UnifiedError::IoStore::FIoStoreErrorDetails::Release ( ) const
inlinefinalvirtual

Implements IRefCountedObject.

◆ SerializeToCb()

virtual void UE::UnifiedError::IoStore::FIoStoreErrorDetails::SerializeToCb ( FCbWriter Writer,
const FError Error 
) const
inlineoverridevirtual

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