BuildPatchServices::IInstallerError Class Reference

#include <InstallerError.h>

Inheritance diagram for BuildPatchServices::IInstallerError:

Public Types
typedef TFunction< void()>	FOnErrorDelegate

Public Member Functions
virtual	~IInstallerError ()
virtual bool	HasError () const =0
virtual bool	IsCancelled () const =0
virtual bool	CanRetry () const =0
virtual EBuildPatchInstallError	GetErrorType () const =0
virtual FString	GetErrorCode () const =0
virtual FText	GetErrorText () const =0
virtual void	SetError (EBuildPatchInstallError ErrorType, const TCHAR *ErrorSubType, uint32 ErrorCode=0, FText ErrorText=FText::GetEmpty())=0
virtual int32	RegisterForErrors (FOnErrorDelegate Delegate)=0
virtual void	UnregisterForErrors (int32 Handle)=0
virtual void	Reset ()=0

Detailed Description

An interface to fatal error implementation used to report an error or get informed of other errors occurring.

Member Typedef Documentation

FOnErrorDelegate

typedef TFunction<void()> BuildPatchServices::IInstallerError::FOnErrorDelegate

Constructor & Destructor Documentation

~IInstallerError()

virtual BuildPatchServices::IInstallerError::~IInstallerError ( )

inlinevirtual

Member Function Documentation

CanRetry()

virtual bool BuildPatchServices::IInstallerError::CanRetry ( ) const

pure virtual

Get whether the reported error is one which should be capable of recovering with an installation retry.

Returns

true if the installation can retry.

Implemented in BuildPatchServices::FInstallerError.

GetErrorCode()

virtual FString BuildPatchServices::IInstallerError::GetErrorCode ( ) const

pure virtual

Get the error code string for the error which has been reported.

Returns

the reported error code string.

Implemented in BuildPatchServices::FInstallerError.

GetErrorText()

virtual FText BuildPatchServices::IInstallerError::GetErrorText ( ) const

pure virtual

Get the default display text for the error which has been reported.

Returns

the reported error's default display text.

Implemented in BuildPatchServices::FInstallerError.

GetErrorType()

virtual EBuildPatchInstallError BuildPatchServices::IInstallerError::GetErrorType ( ) const

pure virtual

Get the enum value for the error which has been reported.

Returns

the reported enum value.

Implemented in BuildPatchServices::FInstallerError.

HasError()

virtual bool BuildPatchServices::IInstallerError::HasError ( ) const

pure virtual

Get if there has been a fatal error reported.

Returns

true if a fatal error has been set.

Implemented in BuildPatchServices::FInstallerError.

IsCancelled()

virtual bool BuildPatchServices::IInstallerError::IsCancelled ( ) const

pure virtual

Get whether an error reported is a cancellation request.

Returns

true if the error which is set is a cancellation.

Implemented in BuildPatchServices::FInstallerError.

RegisterForErrors()

virtual int32 BuildPatchServices::IInstallerError::RegisterForErrors ( FOnErrorDelegate  Delegate )

pure virtual

Register a delegate to be called upon an error occurring.

Parameters

Delegate

The delegate to be executed on error.

Returns

a handle for this registration, used to unregister.

Implemented in BuildPatchServices::FInstallerError.

Reset()

virtual void BuildPatchServices::IInstallerError::Reset ( )

pure virtual

Reset internal state to be ready for a new process.

Implemented in BuildPatchServices::FInstallerError.

SetError()

virtual void BuildPatchServices::IInstallerError::SetError ( EBuildPatchInstallError  ErrorType, const TCHAR *  ErrorSubType, uint32  ErrorCode = 0, FText  ErrorText = FText::GetEmpty()  )

pure virtual

Report a fatal error that has occurred which should cause other systems to abort.

Parameters

ErrorType	The enum value for the error.
ErrorSubType	The error sub type string for the error.
ErrorCode	The error code for the error. 0 means no additional information.
ErrorText	Optional specific error display text to use instead of the standard generic one.

Implemented in BuildPatchServices::FInstallerError.

UnregisterForErrors()

virtual void BuildPatchServices::IInstallerError::UnregisterForErrors ( int32  Handle )

pure virtual

Unregister a delegate from being called upon an error occurring.

Parameters

Handle

The value that was returned RegisterForErrors for the delegate to be removed.

Implemented in BuildPatchServices::FInstallerError.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Installer/InstallerError.h