FGenericError Struct Reference

Represents a generic error with an error code and an optional exception description. More...

#include "OperatingSystemGenericError.h"

Public Member Functions
FORCEINLINE bool	IsValid () const
	Checks if the struct is valid.
FORCEINLINE void	Reset ()
	Resets the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct.
	FGenericError ()
	Default constructor for FGenericError. Initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members.
	FGenericError (const FText &ErrorCode)
	Constructs a FGenericError object with the given error code.
	FGenericError (const FText &ErrorCode, const FText &ErrorExceptionDescription)
	Constructs a FGenericError object with the given error code and exception description.

Public Attributes
FText	ErrorCode
FText	ErrorExceptionDescription

Detailed Description

Represents a generic error with an error code and an optional exception description.

Constructor & Destructor Documentation

FGenericError() [1/3]

FGenericError::FGenericError ( )

inline

Default constructor for FGenericError. Initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members.

FGenericError() [2/3]

FGenericError::FGenericError ( const FText & ErrorCode )

inlineexplicit

Constructs a FGenericError object with the given error code.

Parameters

ErrorCode

The error code to set for the FGenericError object.

This constructor initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct. The bIsValid member is set to true if the ErrorCode is not empty or whitespace, and false otherwise. It also ensures that the ErrorCode is not empty and raises an error if it is.

FGenericError() [3/3]

FGenericError::FGenericError ( const FText & ErrorCode, const FText & ErrorExceptionDescription )

inline

Constructs a FGenericError object with the given error code and exception description.

Parameters

ErrorCode	The error code to set for the FGenericError object.
ErrorExceptionDescription	The exception description to set for the FGenericError object.

This constructor initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct. The bIsValid member is set to true if the ErrorCode is not empty or whitespace, and false otherwise. It also ensures that both the ErrorCode and ErrorExceptionDescription are not empty, and raises an error if either of them is empty.

Member Function Documentation

IsValid()

FORCEINLINE bool FGenericError::IsValid ( ) const

inline

Checks if the struct is valid.

Returns

True if the struct is valid, false otherwise.

Here is the caller graph for this function:

Reset()

FORCEINLINE void FGenericError::Reset ( )

inline

Resets the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct.

Here is the caller graph for this function:

Member Data Documentation

ErrorCode

FText FGenericError::ErrorCode

Typically an error code like ERR_SOMETHING_HAPPENED or 0x77000111 etc.

ErrorExceptionDescription

FText FGenericError::ErrorExceptionDescription

Optional exception description.

---

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

• Source/OperatingSystemSimulator/Public/OperatingSystemGenericError.h