Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FConfigFile > Write > FConfigFile::Write

Light Theme

Dark Theme

FConfigFile::Write

Write a ConfigFile to the ginve Filename, constructed from the given SectionTexts, in the given order, with sections in *this overriding sections in SectionTexts

Windows

MacOS

Linux

References

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

Syntax

bool Write
(
    const FString & Filename,
    bool bDoRemoteWrite,
    TMap< FString, FString > & InOutSectionTexts,
    const TArray< FString > & InSectionOrder
)

Remarks

Write a ConfigFile to the ginve Filename, constructed from the given SectionTexts, in the given order, with sections in *this overriding sections in SectionTexts

Returns

TRUE if the write was successful

Parameters

Parameter	Description
Filename	The file to write to
bDoRemoteWrite	If true, also write the file to FRemoteConfig::Get()
InOutSectionTexts	A map from section name to existing text for that section; text does not include the name of the section. Entries in the TMap that also exist in *this will be updated. If the empty string is present, it will be written out first (it is interpreted as a prefix before the first section)
InSectionOrder	List of section names in the order in which each section should be written to disk, from e.g. the existing file. Any section in this array that is not found in InOutSectionTexts will be ignored. Any section in InOutSectionTexts that is not in this array will be appended to the end. Duplicate entries are ignored; the first found index is used.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss