Navigation
Unreal Engine C++ API Reference > Runtime > Core > Misc
Inheritance Hierarchy
- TMapBase
- TSortableMapBase
- TMap
- FConfigFile
- FLocalizationConfigurationScript
References
Module | Core |
Header | /Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h |
Include | #include "Misc/ConfigCacheIni.h" |
Syntax
class FConfigFile : public TMap< FString, FConfigSection >
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
bool | bHasPlatformName | |
![]() |
TArray< FConfigCommandlineOverride > | CommandlineOptions | The collection of overrides which stemmed from the commandline |
![]() |
bool | Dirty | |
![]() |
FName | Name | The name of this config file |
![]() |
bool | NoSave | |
![]() |
FString | PlatformName | |
![]() |
FConfigFile * | SourceConfigFile | The untainted config file which contains the coalesced base/default options. I.e. No Saved/ options |
![]() |
FString | SourceEngineConfigDir | Locations where this file may have come from - used to merge with non-standard ini locations. |
![]() |
FConfigFileHierarchy | SourceIniHierarchy | The collection of source files which were used to generate this file. |
![]() |
FString | SourceProjectConfigDir |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FConfigFile () |
||
![]() |
FConfigFile
(
int32 |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() |
~FConfigFile () |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddDynamicLayerToHierarchy
(
const FString& Filename |
Appends a new INI file to the SourceIniHierarchy and combines it with the current contents |
![]() |
void | AddMissingProperties
(
const FConfigFile& InSourceFile |
Adds any properties that exist in InSourceFile that this config file is missing |
![]() ![]() |
void | AppendExportedPropertyLine
(
FString& Out, |
Append a correctly escaped line to add to the config file for the given property |
![]() |
bool | ||
![]() |
void | CombineFromBuffer
(
const FString& Buffer, |
|
![]() ![]() |
bool | DoesSectionExist
(
const TCHAR* Section |
|
![]() |
void | Dump
(
FOutputDevice& Ar |
|
![]() |
FConfigSection * | FindOrAddSection
(
const FString& Name |
Looks for a section by name, and creates an empty one if it can't be found |
![]() ![]() |
FString | GenerateExportedPropertyLine
(
const FString& PropertyName, |
Generate a correctly escaped line to add to the config file for the given property |
![]() ![]() |
int32 | ||
![]() ![]() |
bool | GetBool
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetDouble
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetFloat
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetInt
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetInt64
(
const TCHAR* Section, |
|
![]() ![]() |
bool | ||
![]() ![]() |
bool | ||
![]() ![]() |
int32 | ||
![]() ![]() |
bool | GetValue
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetValue
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetValue
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetValue
(
const TCHAR* Section, |
|
![]() ![]() |
bool | GetValue
(
const TCHAR* Section, |
|
![]() ![]() |
bool | ||
![]() ![]() |
bool | Generic versions for use with templates | |
![]() ![]() |
bool | OverrideFileFromCommandline
(
FString& Filename |
Checks the command line for any overridden config file settings |
![]() ![]() |
void | OverrideFromCommandline
(
FConfigFile* File, |
Checks the command line for any overridden config settings |
![]() |
void | ProcessInputFileContents
(
FStringView Contents, |
Process the contents of an .ini file that has been read into an FString |
![]() |
void | Check the source hierarchy which was loaded without any user changes from the Config/Saved dir. | |
![]() |
void | ||
![]() |
void | ||
![]() |
void | SetBool
(
const TCHAR* Section, |
|
![]() |
void | SetDouble
(
const TCHAR* Section, |
|
![]() |
void | SetFloat
(
const TCHAR* Section, |
|
![]() |
void | SetInt64
(
const TCHAR* Section, |
|
![]() |
void | SetString
(
const TCHAR* Section, |
|
![]() |
void | ||
![]() ![]() |
bool | ShouldExportQuotedString
(
const FString& PropertyValue |
Checks if the PropertyValue should be exported in quotes when writing the ini to disk. |
![]() |
void | UpdateSections
(
const TCHAR* DiskFilename, |
Saves only the sections in this FConfigFile into the given file. |
![]() |
bool | UpdateSinglePropertyInSection
(
const TCHAR* DiskFilename, |
Update a single property in the config file, for the section that is specified. |
![]() |
bool | Write this ConfigFile to the given Filename, constructed the text from the config sections in *this, prepended by the optional PrefixText | |
![]() ![]() |
bool | Whether to write a temp file then move it to it's destination when saving. | |
![]() |
void | WriteToString
(
FString& InOutText, |
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 | |
---|---|---|---|
![]() ![]() |
bool | operator!=
(
const FConfigFile& Other |
|
![]() ![]() |
bool | operator==
(
const FConfigFile& Other |
Deprecated Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddDynamicLayerToHeirarchy
(
const FString& Filename |
Call AddDynamicLayerToHierarchy. You also may need to call GetConfigFilename to get the right FConfigFile |
![]() |
void | CombineFromBuffer
(
const FString& Buffer |
Use CombineFromBuffer that takes FileHint |
![]() |
void | ProcessInputFileContents
(
const FString& Buffer |
Use ProcessInputFileContents that takes FileHint |