IBuildInstaller.h File Reference

#include "CoreMinimal.h"
#include "BuildPatchState.h"
#include "BuildPatchMessage.h"

Go to the source code of this file.

Classes
struct	FBuildInstallStats
class	IBuildInstaller

Namespaces
namespace	InstallErrorPrefixes
namespace	BuildPatchServices

Macros
#define	CASE_ENUM_TO_STR(Value)   case EBuildPatchInstallError::Value: return TEXT(#Value)
#define	RETURN_IF_EQUAL(Value)   if (FCString::Stricmp(Buffer, TEXT(#Value)) == 0) { Error = EBuildPatchInstallError::Value; return; }
#define	CASE_ENUM_TO_STR(Value)   case EBuildPatchDownloadHealth::Value: return TEXT(#Value)
#define	RETURN_IF_EQUAL(Value)   if (FCString::Stricmp(Buffer, TEXT(#Value)) == 0) { Error = EBuildPatchDownloadHealth::Value; return; }

Typedefs
typedef TSharedPtr< IBuildInstaller, ESPMode::ThreadSafe >	IBuildInstallerPtr
typedef TSharedRef< IBuildInstaller, ESPMode::ThreadSafe >	IBuildInstallerRef
typedef TWeakPtr< IBuildInstaller, ESPMode::ThreadSafe >	IBuildInstallerWeakPtr

Enumerations
enum class	EBuildPatchInstallError {   NoError = 0 , DownloadError = 1 , FileConstructionFail = 2 , MoveFileToInstall = 3 ,   BuildVerifyFail = 4 , ApplicationClosing = 5 , ApplicationError = 6 , UserCanceled = 7 ,   PrerequisiteError = 8 , InitializationError = 9 , PathLengthExceeded = 10 , OutOfDiskSpace = 11 ,   NumInstallErrors }
enum class	EBuildPatchDownloadHealth {   Disconnected = 0 , Poor , OK , Good ,   Excellent , NUM_Values }

Functions
const TCHAR *	LexToString (EBuildPatchInstallError Error)
void	LexFromString (EBuildPatchInstallError &Error, const TCHAR *Buffer)
const TCHAR *	LexToString (EBuildPatchDownloadHealth Error)
void	LexFromString (EBuildPatchDownloadHealth &Error, const TCHAR *Buffer)

Macro Definition Documentation

CASE_ENUM_TO_STR [1/2]

#define CASE_ENUM_TO_STR

(

Value

)

case EBuildPatchInstallError::Value: return TEXT(#Value)

CASE_ENUM_TO_STR [2/2]

#define CASE_ENUM_TO_STR

(

Value

)

case EBuildPatchDownloadHealth::Value: return TEXT(#Value)

RETURN_IF_EQUAL [1/2]

#define RETURN_IF_EQUAL

(

Value

)

if (FCString::Stricmp(Buffer, TEXT(#Value)) == 0) { Error = EBuildPatchInstallError::Value; return; }

RETURN_IF_EQUAL [2/2]

#define RETURN_IF_EQUAL

(

Value

)

if (FCString::Stricmp(Buffer, TEXT(#Value)) == 0) { Error = EBuildPatchDownloadHealth::Value; return; }

Typedef Documentation

IBuildInstallerPtr

typedef TSharedPtr<IBuildInstaller, ESPMode::ThreadSafe> IBuildInstallerPtr

IBuildInstallerRef

typedef TSharedRef<IBuildInstaller, ESPMode::ThreadSafe> IBuildInstallerRef

IBuildInstallerWeakPtr

typedef TWeakPtr<IBuildInstaller, ESPMode::ThreadSafe> IBuildInstallerWeakPtr

Enumeration Type Documentation

EBuildPatchDownloadHealth

enum class EBuildPatchDownloadHealth

strong

Enumerator
Disconnected
Poor
OK
Good
Excellent
NUM_Values

EBuildPatchInstallError

enum class EBuildPatchInstallError

strong

Declares the error type enum for use with the error system

Enumerator
NoError
DownloadError
FileConstructionFail
MoveFileToInstall
BuildVerifyFail
ApplicationClosing
ApplicationError
UserCanceled
PrerequisiteError
InitializationError
PathLengthExceeded
OutOfDiskSpace
NumInstallErrors

Function Documentation

LexFromString() [1/2]

void LexFromString ( EBuildPatchDownloadHealth &  Error, const TCHAR *  Buffer  )

inline

LexFromString() [2/2]

void LexFromString ( EBuildPatchInstallError &  Error, const TCHAR *  Buffer  )

inline

LexToString() [1/2]

const TCHAR * LexToString ( EBuildPatchDownloadHealth  Error )

inline

LexToString() [2/2]

const TCHAR * LexToString ( EBuildPatchInstallError  Error )

inline