BuildPatchServices::FInstallerError Class Reference

Inheritance diagram for BuildPatchServices::FInstallerError:

Public Member Functions
	FInstallerError ()
	~FInstallerError ()
virtual bool	HasError () const override
virtual bool	IsCancelled () const override
virtual bool	CanRetry () const override
virtual EBuildPatchInstallError	GetErrorType () const override
virtual FString	GetErrorCode () const override
virtual FText	GetErrorText () const override
virtual void	SetError (EBuildPatchInstallError InErrorType, const TCHAR *InErrorSubType, uint32 InErrorCode, FText InErrorText) override
virtual int32	RegisterForErrors (FOnErrorDelegate Delegate) override
virtual void	UnregisterForErrors (int32 Handle) override
virtual void	Reset () override
Public Member Functions inherited from BuildPatchServices::IInstallerError
virtual	~IInstallerError ()

Additional Inherited Members
Public Types inherited from BuildPatchServices::IInstallerError
typedef TFunction< void()>	FOnErrorDelegate

Constructor & Destructor Documentation

FInstallerError()

BuildPatchServices::FInstallerError::FInstallerError

(

)

~FInstallerError()

BuildPatchServices::FInstallerError::~FInstallerError

(

)

Member Function Documentation

CanRetry()

bool BuildPatchServices::FInstallerError::CanRetry ( ) const

overridevirtual

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

Returns

true if the installation can retry.

Implements BuildPatchServices::IInstallerError.

GetErrorCode()

FString BuildPatchServices::FInstallerError::GetErrorCode ( ) const

overridevirtual

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

Returns

the reported error code string.

Implements BuildPatchServices::IInstallerError.

GetErrorText()

FText BuildPatchServices::FInstallerError::GetErrorText ( ) const

overridevirtual

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

Returns

the reported error's default display text.

Implements BuildPatchServices::IInstallerError.

GetErrorType()

EBuildPatchInstallError BuildPatchServices::FInstallerError::GetErrorType ( ) const

overridevirtual

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

Returns

the reported enum value.

Implements BuildPatchServices::IInstallerError.

HasError()

bool BuildPatchServices::FInstallerError::HasError ( ) const

overridevirtual

Get if there has been a fatal error reported.

Returns

true if a fatal error has been set.

Implements BuildPatchServices::IInstallerError.

IsCancelled()

bool BuildPatchServices::FInstallerError::IsCancelled ( ) const

overridevirtual

Get whether an error reported is a cancellation request.

Returns

true if the error which is set is a cancellation.

Implements BuildPatchServices::IInstallerError.

RegisterForErrors()

int32 BuildPatchServices::FInstallerError::RegisterForErrors ( FOnErrorDelegate  Delegate )

overridevirtual

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.

Implements BuildPatchServices::IInstallerError.

Reset()

void BuildPatchServices::FInstallerError::Reset ( )

overridevirtual

Reset internal state to be ready for a new process.

Implements BuildPatchServices::IInstallerError.

SetError()

void BuildPatchServices::FInstallerError::SetError ( EBuildPatchInstallError  ErrorType, const TCHAR *  ErrorSubType, uint32  ErrorCode, FText  ErrorText  )

overridevirtual

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.

Implements BuildPatchServices::IInstallerError.

UnregisterForErrors()

void BuildPatchServices::FInstallerError::UnregisterForErrors ( int32  Handle )

overridevirtual

Unregister a delegate from being called upon an error occurring.

Parameters

Handle

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

Implements BuildPatchServices::IInstallerError.

---

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

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