1. Epic GamesDeveloper
  3. FConfigFile

FConfigFile

One config file.

API > API/Runtime > API/Runtime/Core

One config file.

   
Name FConfigFile
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h
Include Path #include "Misc/ConfigCacheIni.h"

Syntax

class FConfigFile : private TMap< FString, FConfigSection >

Inheritance Hierarchy

  • TMap → FConfigFile

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FConfigFile ( int32
)

   Misc/ConfigCacheIni.h  
  Misc/ConfigCacheIni.h  

FConfigFile ( FConfigFile&& Other
)

   Misc/ConfigCacheIni.h  

FConfigFile ( const FConfigFile& Other
)

   Misc/ConfigCacheIni.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FConfigFile()

   Misc/ConfigCacheIni.h  

Typedefs

Name Type Remarks Include Path
SectionType FConfigSection   Misc/ConfigCacheIni.h

Constants

Name Type Remarks Include Path
ConfigFileMapLock FTransactionallySafeRWLock   Misc/ConfigCacheIni.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCanSaveAllSections bool By default, we allow saving - this is going to be applied to config files that are not loaded from disk (when loading, this will get set to false, and then the ini sections will be checked) Misc/ConfigCacheIni.h  
bHasPlatformName bool   Misc/ConfigCacheIni.h  
bPythonConfigParserMode bool   Misc/ConfigCacheIni.h  
Branch FConfigBranch *   Misc/ConfigCacheIni.h  
CommandlineOptions TArray< FConfigCommandlineOverride > The collection of overrides which stemmed from the commandline Misc/ConfigCacheIni.h  
Dirty bool   Misc/ConfigCacheIni.h  
LoadType UE::ConfigAccessTracking::ELoadType   Misc/ConfigCacheIni.h  
Name FName The name of this config file Misc/ConfigCacheIni.h  
NoSave bool   Misc/ConfigCacheIni.h  
PlatformName FString   Misc/ConfigCacheIni.h  
Tag FName Optional tag, (can tag files per plugin, etc) Misc/ConfigCacheIni.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ChangeTracker FConfigCommandStream * If this is set, then we track changes made to sections for saving or replaying later (currently unused) Misc/ConfigCacheIni.h  
FConfigContext friend   Misc/ConfigCacheIni.h  
FileAccess TRefCountPtr< UE::ConfigAccessTracking::FFile >   Misc/ConfigCacheIni.h  
PerObjectConfigArrayOfStructKeys TMap< FString, TMap< FName, FString > > This holds per-object config class names, with their ArrayOfStructKeys. Misc/ConfigCacheIni.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

ValueType & Add ( KeyType&& InKey,
const ValueType& InValue
)

   Misc/ConfigCacheIni.h  

ValueType & Add ( KeyType&& InKey,
ValueType&& InValue
)

   Misc/ConfigCacheIni.h  

ValueType & Add ( const KeyType& InKey,
ValueType&& InValue
)

   Misc/ConfigCacheIni.h  

ValueType & Add ( const KeyType& InKey,
const ValueType& InValue
)

   Misc/ConfigCacheIni.h  

void AddDynamicLayerToHierarchy ( const FString& Filename
)

 Appends a new INI file to the SourceIniHierarchy and combines it with the current contents Misc/ConfigCacheIni.h  

void AddMissingProperties ( const FConfigFile& InSourceFile
)

 Adds any properties that exist in InSourceFile that this config file is missing Misc/ConfigCacheIni.h  

bool AddToSection ( const TCHAR* Section,
FName Key,
const FString& Value
)

 Adds the given key/value pair to the Section. Misc/ConfigCacheIni.h  

bool AddUniqueToSection ( const TCHAR* Section,
FName Key,
const FString& Value
)

 Adds the given key/value pair to the Section, if the pair didn't already exist This is equivalent to the + operator in .ini files Misc/ConfigCacheIni.h  

void Append ( TMap< FString, FConfigSection > Other
)

   Misc/ConfigCacheIni.h  

bool ApplyFile ( const FConfigCommandStream* File
)

 Apply the contents of the given file (which must have non-Combined ValueTypes stored in it, it is a logic error otherwise and will assert) The values in this file will be Combined type Misc/ConfigCacheIni.h  

TRangedForConstIterator begin()

   Misc/ConfigCacheIni.h  

bool Combine ( const FString& Filename
)

   Misc/ConfigCacheIni.h  

void CombineFromBuffer ( const FString& Buffer,
const FString& FileHint
)

   Misc/ConfigCacheIni.h  

bool Contains ( const FString& SectionName
) const

   Misc/ConfigCacheIni.h  

bool DoesSectionExist ( const TCHAR* Section
) const

   Misc/ConfigCacheIni.h  

void Dump ( FOutputDevice& Ar
)

   Misc/ConfigCacheIni.h  

void Empty ( int32 ExpectedNumElements
)

   Misc/ConfigCacheIni.h  

TRangedForConstIterator end()

   Misc/ConfigCacheIni.h  

const FConfigSection * FindOrAddConfigSection ( const FString& Name
)

 Looks for a section by name, and creates an empty one if it can't be found Misc/ConfigCacheIni.h  

const FConfigSection * FindSection ( const FString& SectionName
) const

   Misc/ConfigCacheIni.h  

int32 GetArray ( const TCHAR* Section,
const TCHAR* Key,
TArray< FString >& Value
) const

   Misc/ConfigCacheIni.h  

bool GetBool ( const TCHAR* Section,
const TCHAR* Key,
bool& Value
) const

   Misc/ConfigCacheIni.h  

bool GetDouble ( const TCHAR* Section,
const TCHAR* Key,
double& Value
) const

   Misc/ConfigCacheIni.h  
  Misc/ConfigCacheIni.h  

bool GetFloat ( const TCHAR* Section,
const TCHAR* Key,
float& Value
) const

   Misc/ConfigCacheIni.h  

bool GetInt ( const TCHAR* Section,
const TCHAR* Key,
int32& Value
) const

   Misc/ConfigCacheIni.h  

bool GetInt64 ( const TCHAR* Section,
const TCHAR* Key,
int64& Value
) const

   Misc/ConfigCacheIni.h  

int32 GetKeys ( TArray< FString >& Keys
) const

   Misc/ConfigCacheIni.h  

int32 GetKeys ( TSet< FString >& Keys
) const

   Misc/ConfigCacheIni.h  

bool GetString ( const TCHAR* Section,
const TCHAR* Key,
FString& Value
) const

   Misc/ConfigCacheIni.h  

bool GetText ( const TCHAR* Section,
const TCHAR* Key,
FText& Value
) const

   Misc/ConfigCacheIni.h  

bool GetUInt ( const TCHAR* Section,
const TCHAR* Key,
uint32& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
float& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
int32& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
FText& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
FString& Value
) const

 Generic versions for use with templates Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
int64& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
bool& Value
) const

   Misc/ConfigCacheIni.h  

int32 GetValue ( const TCHAR* Section,
const TCHAR* Key,
TArray< FString >& Value
) const

   Misc/ConfigCacheIni.h  

bool GetValue ( const TCHAR* Section,
const TCHAR* Key,
double& Value
) const

   Misc/ConfigCacheIni.h  

bool IsEmpty()

   Misc/ConfigCacheIni.h  

int32 Num()

   Misc/ConfigCacheIni.h  

void ProcessInputFileContents ( FStringView Contents,
const FString& FileHint
)

 Process the contents of an .ini file that has been read into an FString Misc/ConfigCacheIni.h  
Check the source hierarchy which was loaded without any user changes from the Config/Saved dir. Misc/ConfigCacheIni.h  

void Read ( const FString& Filename
)

   Misc/ConfigCacheIni.h  

int32 Remove ( KeyConstPointerType InKey
)

   Misc/ConfigCacheIni.h  

bool RemoveFromSection ( const TCHAR* Section,
FName Key,
const FString& Value
)

 Removes every entry in the Section that has the Key/Value pair This is equivalent to the - operator in .ini files (although it will remove all instances of the pair, not just a single one) Misc/ConfigCacheIni.h  

bool RemoveKeyFromSection ( const TCHAR* Section,
FName Key
)

 Removes every entry in the Section that has Key, no matter what the Value is This is equivalent to the ! operator in .ini files Misc/ConfigCacheIni.h  

void Reset()

   Misc/ConfigCacheIni.h  

bool ResetKeyInSection ( const TCHAR* Section,
FName Key
)

 Similar to RemvoeKeyFromSection, but if this File's changes are being tracked, then we remove all changes to the the key that have been tracked. Misc/ConfigCacheIni.h  

void SetArray ( const TCHAR* Section,
const TCHAR* Key,
const TArray< FString >& Value
)

   Misc/ConfigCacheIni.h  

void SetBool ( const TCHAR* Section,
const TCHAR* Key,
bool Value
)

   Misc/ConfigCacheIni.h  

void SetDouble ( const TCHAR* Section,
const TCHAR* Key,
double Value
)

   Misc/ConfigCacheIni.h  

void SetFloat ( const TCHAR* Section,
const TCHAR* Key,
float Value
)

   Misc/ConfigCacheIni.h  

bool SetInSection ( const TCHAR* SectionName,
FName Key,
const FString& Value
)

 Sets the given key/value pair to the Section in the given File. Misc/ConfigCacheIni.h  

void SetInt64 ( const TCHAR* Section,
const TCHAR* Key,
const int64 Value
)

   Misc/ConfigCacheIni.h  

void SetString ( const TCHAR* Section,
const TCHAR* Key,
const TCHAR* Value
)

   Misc/ConfigCacheIni.h  

void SetText ( const TCHAR* Section,
const TCHAR* Key,
const FText& Value
)

   Misc/ConfigCacheIni.h  

void SuppressReporting()

   Misc/ConfigCacheIni.h  

void UpdateSections ( const TCHAR* DiskFilename,
const TCHAR* IniRootName,
const TCHAR* OverridePlatform
)

 Saves only the sections in this FConfigFile into the given file. Misc/ConfigCacheIni.h  

bool UpdateSinglePropertyInSection ( const TCHAR* DiskFilename,
const TCHAR* PropertyName,
const TCHAR* SectionName
)

 Update a single property in the config file, for the section that is specified. Misc/ConfigCacheIni.h  

bool Write ( const FString& Filename,
bool bDoRemoteWrite,
const FString& PrefixText
)

 Write this ConfigFile to the given Filename, constructed the text from the config sections in *this, prepended by the optional PrefixText Misc/ConfigCacheIni.h  

void WriteToString ( FString& InOutText,
const FString& SimulatedFilename,
const FString& PrefixText
)

 Write this ConfigFile to the given string, constructed the text from the config sections in *this, prepended by the optional PrefixText Misc/ConfigCacheIni.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddStaticLayersToHierarchy ( FConfigContext& Context
)

   Misc/ConfigCacheIni.h  

static void AppendExportedPropertyLine ( FString& Out,
const FString& PropertyName,
const FString& PropertyValue
)

 Append a correctly escaped line to add to the config file for the given property Misc/ConfigCacheIni.h  

static FString GenerateExportedPropertyLine ( const FString& PropertyName,
const FString& PropertyValue
)

 Generate a correctly escaped line to add to the config file for the given property Misc/ConfigCacheIni.h  

static bool OverrideFileFromCommandline ( FString& Filename
)

 Checks the command line for any overridden config file settings Misc/ConfigCacheIni.h  

static void OverrideFromCommandline ( FConfigCommandStream* File,
const FString& Filename
)

 Looks for any overrides on the commandline for this file Misc/ConfigCacheIni.h  

static void OverrideFromCommandline ( FConfigFile* File,
const FString& Filename
)

 Checks the command line for any overridden config settings Misc/ConfigCacheIni.h  

static bool ShouldExportQuotedString ( const FString& PropertyValue
)

 Checks if the PropertyValue should be exported in quotes when writing the ini to disk. Misc/ConfigCacheIni.h  

static bool WriteTempFileThenMove()

 Whether to write a temp file then move it to it's destination when saving. Misc/ConfigCacheIni.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FConfigFile& Other
) const

   Misc/ConfigCacheIni.h  
  Misc/ConfigCacheIni.h  

FConfigFile & operator= ( const FConfigFile& Other
)

   Misc/ConfigCacheIni.h  

bool operator== ( const FConfigFile& Other
) const

   Misc/ConfigCacheIni.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page