Navigation
API > API/Runtime > API/Runtime/Core
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.
| Name | FStaticErrorDetails |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Experimental/UnifiedError/UnifiedError.h |
| Include Path | #include "Experimental/UnifiedError/UnifiedError.h" |
Syntax
class FStaticErrorDetails : public UE::UnifiedError::IErrorDetails
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStaticErrorDetails
(
const FAnsiStringView& InErrorName, |
TODO: convert AnsiStringView to UTF8StringView when c++ 20 is supported. | Experimental/UnifiedError/UnifiedError.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FStaticErrorDetails() |
Experimental/UnifiedError/UnifiedError.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| StaticDetailsTypeId | const uint32 | Experimental/UnifiedError/UnifiedError.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ErrorFormatString | FText | Experimental/UnifiedError/UnifiedError.h | ||
| ErrorName | const FAnsiStringView & | Experimental/UnifiedError/UnifiedError.h | ||
| ModuleName | const FAnsiStringView & | Experimental/UnifiedError/UnifiedError.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FAnsiStringView & GetErrorCodeString() |
GetErrorCodeString; Accessor for ErrorName. Can be called directly on FStaticErrorDetails object. See also: FError::GetErrorDetails. | Experimental/UnifiedError/UnifiedError.h | |
const FAnsiStringView & GetModuleIdString() |
GetModuleIdString; accessor for ModuleName. Can be called directly on FStaticErrorDetails object See also: FError::GetErrorDetails. | Experimental/UnifiedError/UnifiedError.h |
Overridden from IErrorDetails
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetErrorDetailsTypeId() |
GetErrorDetialsTypeId; Simple type information for error details, generated using hash of details name See also: #define FERROR_DETAILS. | Experimental/UnifiedError/UnifiedError.h | |
virtual const FAnsiStringView GetErrorDetailsTypeName() |
Experimental/UnifiedError/UnifiedError.h | ||
| GetErrorFormatString; return the localized format text generated in DECLARE_ERROR macro. | Experimental/UnifiedError/UnifiedError.h | ||
virtual void GetErrorProperties
(
const FError& Error, |
GetErrorProperties; Adds error properties exposed by this error details object to the OutProperties value FStaticErrorDetails includes error details all errors have ErrorCode, ModuleId, ErrorCodeString, ModuleIdString These can be used in any error format string see also GetErrorFormatString. | Experimental/UnifiedError/UnifiedError.h |
Overridden from IRefCountedObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FReturnedRefCountValue AddRef() |
IRefCountedObject implementation FStaticErrorDetails is statically allocated, make sure it is never released. | Experimental/UnifiedError/UnifiedError.h | |
virtual uint32 GetRefCount() |
TODO (SOL-7350): mark this function as deprecated; clean up existing callers. | Experimental/UnifiedError/UnifiedError.h | |
virtual uint32 Release() |
TODO (SOL-7350): return FReturnedRefCountValue from Release(); clean up call sites which rely on its return value. | Experimental/UnifiedError/UnifiedError.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 StaticGetErrorDetailsTypeId() |
Experimental/UnifiedError/UnifiedError.h |