Navigation
API > API/Runtime > API/Runtime/Core
ErrorStruct is the public type containing fields declared with the error, i.e. ModuleNamespace::FErrorName ErrorDeclarationType is the private type containing information generated by the macro These could be merged.
| Name | TMandatoryErrorDetails |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Experimental/UnifiedError/UnifiedErrorDetails.h |
| Include Path | #include "Experimental/UnifiedError/UnifiedErrorDetails.h" |
Syntax
template<CErrorDeclaration ErrorDeclarationType>
class TMandatoryErrorDetails : public UE::UnifiedError::TMandatoryErrorDetailsRefCounting< ErrorDeclarationType >
Inheritance Hierarchy
- TAtomicRefCount → FRefCountedObject → TMandatoryErrorDetailsRefCounting → TMandatoryErrorDetails
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TMandatoryErrorDetails
(
PayloadType&& InPayload |
Experimental/UnifiedError/UnifiedErrorDetails.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PayloadType | ErrorDeclarationType::PayloadType | Experimental/UnifiedError/UnifiedErrorDetails.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Payload | PayloadType | If this type is empty, there are no instance fields and all instances of this error can share the same pointer to this struct. | Experimental/UnifiedError/UnifiedErrorDetails.h |
Functions
Public
Public Virtual
Overridden from FMandatoryErrorDetails
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FUtf8StringView GetErrorCodeString
(
const FError& Error |
Experimental/UnifiedError/UnifiedErrorDetails.h | ||
virtual FUtf8StringView GetModuleIdAndErrorCodeString
(
const FError& Error |
Experimental/UnifiedError/UnifiedErrorDetails.h | ||
virtual FUtf8StringView GetModuleIdString
(
const FError& Error |
Experimental/UnifiedError/UnifiedErrorDetails.h |
Overridden from IErrorDetails
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FMemoryView GetErrorContext() |
Returns the stored context for this error if any. Must be used with a type checking facility (see DeclarationHash). | Experimental/UnifiedError/UnifiedErrorDetails.h | |
virtual uint64 GetErrorDetailsTypeId () |
GetErrorDetialsTypeId; Simple type information for error details, generated using hash of details name | Experimental/UnifiedError/UnifiedErrorDetails.h | |
virtual void SerializeToCompactBinary
(
FCbWriter& Writer |
Serialize these details to compact binary for logging, analytics, localization etc. | Experimental/UnifiedError/UnifiedErrorDetails.h |