FConfigValue Struct Reference

#include <ConfigCacheIni.h>

Public Types
enum class	EValueType : uint8 {   Set , ArrayAdd , ArrayAddUnique , Remove ,   Clear , InitializeToEmpty , ArrayOfStructKey , POCArrayOfStructKey ,   Combined , ArrayCombined }

Public Member Functions
	FConfigValue ()
	FConfigValue (const FConfigSection *InSection, FName InValueName, EValueType Type=EValueType::Combined)
	FConfigValue (const TCHAR *InValue, EValueType Type=EValueType::Combined)
	FConfigValue (const FConfigSection *InSection, FName InValueName, const TCHAR *InValue, EValueType Type=EValueType::Combined)
	FConfigValue (const FString &InValue, EValueType Type=EValueType::Combined)
	FConfigValue (const FConfigSection *InSection, FName InValueName, const FString &InValue, EValueType Type=EValueType::Combined)
	FConfigValue (FString &&InValue, EValueType Type=EValueType::Combined)
	FConfigValue (const FConfigSection *InSection, FName InValueName, FString &&InValue, EValueType Type=EValueType::Combined)
	FConfigValue (const FConfigValue &InConfigValue)
	FConfigValue (FConfigValue &&InConfigValue)
FConfigValue &	operator= (FConfigValue &&RHS)
FConfigValue &	operator= (const FConfigValue &RHS)
FConfigValue &	operator= (const TCHAR *RHS)
FConfigValue &	operator= (const FString &RHS)
FConfigValue &	operator= (FString &&RHS)
FString	GetValue () const
const FString &	GetSavedValue () const
bool	operator== (const FConfigValue &Other) const
bool	operator!= (const FConfigValue &Other) const
UE_FORCEINLINE_HINT FString	GetValueForWriting () const
const FString &	GetSavedValueForWriting () const

Static Public Member Functions
static CORE_API bool	ExpandValue (const FString &InCollapsedValue, FString &OutExpandedValue)
static CORE_API FString	ExpandValue (const FString &InCollapsedValue)
static CORE_API bool	CollapseValue (const FString &InExpandedValue, FString &OutCollapsedValue)
static CORE_API FString	CollapseValue (const FString &InExpandedValue)

Public Attributes
EValueType	ValueType

Friends
class	FConfigCacheIni
class	FConfigFile
class	FConfigBranch
struct	FDetailedConfigMemUsage
FArchive &	operator<< (FArchive &Ar, FConfigValue &ConfigValue)
void	operator<< (FStructuredArchive::FSlot Slot, FConfigValue &ConfigValue)

Member Enumeration Documentation

EValueType

enum class FConfigValue::EValueType : uint8

strong

Enumerator
Set
ArrayAdd
ArrayAddUnique
Remove
Clear
InitializeToEmpty
ArrayOfStructKey
POCArrayOfStructKey
Combined
ArrayCombined

Constructor & Destructor Documentation

FConfigValue() [1/10]

FConfigValue::FConfigValue ( )

inline

FConfigValue() [2/10]

FConfigValue::FConfigValue ( const FConfigSection *  InSection, FName  InValueName, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [3/10]

FConfigValue::FConfigValue ( const TCHAR *  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [4/10]

FConfigValue::FConfigValue ( const FConfigSection *  InSection, FName  InValueName, const TCHAR *  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [5/10]

FConfigValue::FConfigValue ( const FString &  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [6/10]

FConfigValue::FConfigValue ( const FConfigSection *  InSection, FName  InValueName, const FString &  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [7/10]

FConfigValue::FConfigValue ( FString &&  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [8/10]

FConfigValue::FConfigValue ( const FConfigSection *  InSection, FName  InValueName, FString &&  InValue, EValueType  Type = EValueType::Combined  )

inline

FConfigValue() [9/10]

FConfigValue::FConfigValue ( const FConfigValue &  InConfigValue )

inline

FConfigValue() [10/10]

FConfigValue::FConfigValue ( FConfigValue &&  InConfigValue )

inline

Member Function Documentation

CollapseValue() [1/2]

FString FConfigValue::CollapseValue ( const FString &  InExpandedValue )

static

Given an expanded config value, try and produce a collapsed version of it (adding any placeholder tokens).

Parameters

InExpandedValue

The expanded config value to try and expand.

Returns

The collapsed version of the config value.

CollapseValue() [2/2]

bool FConfigValue::CollapseValue ( const FString &  InExpandedValue, FString &  OutCollapsedValue  )

static

Given an expanded config value, try and produce a collapsed version of it (adding any placeholder tokens).

Parameters

InExpandedValue	The expanded config value to try and expand.
OutCollapsedValue	String to fill with the collapsed version of the config value.

Returns

true if collapsing occurred, false if the collapsed and expanded values are equal.

ExpandValue() [1/2]

FString FConfigValue::ExpandValue ( const FString &  InCollapsedValue )

static

Given a collapsed config value, try and produce an expanded version of it (removing any placeholder tokens).

Parameters

InCollapsedValue

The collapsed config value to try and expand.

Returns

The expanded version of the config value.

ExpandValue() [2/2]

bool FConfigValue::ExpandValue ( const FString &  InCollapsedValue, FString &  OutExpandedValue  )

static

Given a collapsed config value, try and produce an expanded version of it (removing any placeholder tokens).

Parameters

InCollapsedValue	The collapsed config value to try and expand.
OutExpandedValue	String to fill with the expanded version of the config value.

Returns

true if expansion occurred, false if the collapsed and expanded values are equal.

GetSavedValue()

const FString & FConfigValue::GetSavedValue ( ) const

inline

GetSavedValueForWriting()

const FString & FConfigValue::GetSavedValueForWriting ( ) const

inline

GetValue()

FString FConfigValue::GetValue ( ) const

inline

GetValueForWriting()

UE_FORCEINLINE_HINT FString FConfigValue::GetValueForWriting ( ) const

inline

Gets the expanded value (GetValue) without marking it as having been accessed for e.g. writing out to a ConfigFile to disk

operator!=()

bool FConfigValue::operator!= ( const FConfigValue &  Other ) const

inline

operator=() [1/5]

FConfigValue & FConfigValue::operator= ( const FConfigValue &  RHS )

inline

operator=() [2/5]

FConfigValue & FConfigValue::operator= ( const FString &  RHS )

inline

operator=() [3/5]

FConfigValue & FConfigValue::operator= ( const TCHAR *  RHS )

inline

operator=() [4/5]

FConfigValue & FConfigValue::operator= ( FConfigValue &&  RHS )

inline

operator=() [5/5]

FConfigValue & FConfigValue::operator= ( FString &&  RHS )

inline

operator==()

bool FConfigValue::operator== ( const FConfigValue &  Other ) const

inline

Friends And Related Symbol Documentation

FConfigBranch

friend class FConfigBranch

friend

FConfigCacheIni

friend class FConfigCacheIni

friend

Gets the SavedValue without marking it as having been accessed for e.g. writing out to a ConfigFile to disk

FConfigFile

friend class FConfigFile

friend

FDetailedConfigMemUsage

friend struct FDetailedConfigMemUsage

friend

operator<< [1/2]

FArchive & operator<< ( FArchive &  Ar, FConfigValue &  ConfigValue  )

friend

operator<< [2/2]

void operator<< ( FStructuredArchive::FSlot  Slot, FConfigValue &  ConfigValue  )

friend

Member Data Documentation

ValueType

EValueType FConfigValue::ValueType

---

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

• Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h
• Engine/Source/Runtime/Core/Private/Misc/ConfigCacheIni.cpp