1. Epic GamesDeveloper
  3. FConfigFile

FConfigFile

One config file.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h
Include #include "Misc/ConfigCacheIni.h"

Syntax

class FConfigFile : private TMap< FString, FConfigSection >

Remarks

One config file.

Variables

  Type Name Description
Public variable bool: 1 bCanSaveAllSections 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)
Public variable bool: 1 bHasPlatformName  
Public variable bool: 1 bPythonConfigParserMode  
Public variable FConfigBranch * Branch  
Public variable TArray< FConfigCommandlineOverride > CommandlineOptions The collection of overrides which stemmed from the commandline
Public variable bool: 1 Dirty  
Public variable UE::ConfigAccessTracking::ELoadType LoadType  
Public variable FName Name The name of this config file
Public variable bool: 1 NoSave  
Public variable FString PlatformName  
Public variable FName Tag Optional tag, (can tag files per plugin, etc)

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FConfigFile ( const FConfigFile& Other
)

  
Public function  

FConfigFile ( FConfigFile&& Other
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function ValueType &

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

  
Public function ValueType &

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

  
Public function ValueType &

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

  
Public function ValueType &

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

  
Public function void

AddDynamicLayerToHierarchy ( const FString& Filename
)

 Appends a new INI file to the SourceIniHierarchy and combines it with the current contents
Public function void

AddMissingProperties ( const FConfigFile& InSourceFile
)

 Adds any properties that exist in InSourceFile that this config file is missing
Public function bool

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

 Adds the given key/value pair to the Section.
Public function 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
Public function void  
Public function 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
Public function bool 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
Public function Const TRangedForConstIterator

begin ()

  
Public function TRangedForIterator

begin ()

  
Public function bool

Combine ( const FString& Filename
)

  
Public function void

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

  
Public function Const bool

Contains ( const FString& SectionName
)

  
Public function Const bool

DoesSectionExist ( const TCHAR* Section
)

  
Public function void  
Public function void

Empty ( int32 ExpectedNumElements
)

  
Public function Const TRangedForConstIterator

end ()

  
Public function TRangedForIterator

end ()

  
Public function FConfigSection *

Find ( const FString& SectionName
)

  
Public function Const const FConfigSection *

Find ( const FString& SectionName
)

 Replacement functionality of TMap so we can deprecate the direct access to FConfigSection
Public function ValueType &

FindOrAdd ( const FString& Key
)

  
Public function const FConfigSection *  
Public function FConfigSection *

FindOrAddSection ( const FString& Name
)

 Looks for a section by name, and creates an empty one if it can't be found
Public function Const const FConfigSection *

FindSection ( const FString& SectionName
)

  
Public function Static FString

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

 Generate a correctly escaped line to add to the config file for the given property
Public function Const int32

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const UE::ConfigAccessTracking::FFile *  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const int32

GetKeys ( TArray< FString >& Keys
)

  
Public function Const int32

GetKeys ( TSet< FString >& Keys
)

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const int32

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

  
Public function Const bool

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

 Generic versions for use with templates
Public function Const bool

IsEmpty ()

  
Public function Const int32

Num ()

  
Public function Static bool Checks the command line for any overridden config file settings
Public function Static void Looks for any overrides on the commandline for this file
Public function Static void

OverrideFromCommandline ( FConfigFile* File,
const FString& Filename
)

 Checks the command line for any overridden config settings
Public function void

ProcessInputFileContents ( FStringView Contents,
const FString& FileHint
)

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

Read ( const FString& Filename
)

  
Public function int32  
Public function 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)
Public function 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
Public function void

Reset ()

  
Public function 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.
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function Static bool

ShouldExportQuotedString ( const FString& PropertyValue
)

 Checks if the PropertyValue should be exported in quotes when writing the ini to disk.
Public function void  
Public function void

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

 Saves only the sections in this FConfigFile into the given file.
Public function 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.
Public function 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
Public function Static bool Whether to write a temp file then move it to it's destination when saving.
Public function 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

Operators

  Type Name Description
Public function Const bool

operator!= ( const FConfigFile& Other
)

  
Public function FConfigFile &

operator= ( FConfigFile&& Other
)

  
Public function FConfigFile &

operator= ( const FConfigFile& Other
)

  
Public function Const bool

operator== ( const FConfigFile& Other
)

  

Typedefs

Name Description
SectionType  

Constants

Name Description
ConfigFileMapLock  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page