FConfigCacheIni::LoadExternalIniFile

Load an ini file directly into an [FConfigFile](API\Runtime\Core\Misc\FConfigFile) from the specified config folders, optionally writing to disk.

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

static bool LoadExternalIniFile
(
    FConfigFile & ConfigFile,
    const TCHAR * IniName,
    const TCHAR * EngineConfigDir,
    const TCHAR * SourceConfigDir,
    bool bIsBaseIniName,
    const TCHAR * Platform,
    bool bForceReload,
    bool bWriteDestIni,
    bool bAllowGeneratedIniWhenCooked,
    const TCHAR * GeneratedConfigDir
)

Remarks

Load an ini file directly into an FConfigFile from the specified config folders, optionally writing to disk. The passed in .ini name can be a "base" (Engine, Game) which will be modified by platform and/or commandline override, or it can be a full ini filename (ie WrangleContent) loaded from the Source config directory

Returns

true if the ini file was loaded successfully

Parameters

Parameter

Description

ConfigFile

The output object to fill

IniName

Either a Base ini name (Engine) or a full ini name (WrangleContent). NO PATH OR EXTENSION SHOULD BE USED!

EngineConfigDir

Engine config directory.

SourceConfigDir

Game config directory.

bIsBaseIniName

true if IniName is a Base name, which can be overridden on commandline, etc.

Platform

The platform to use for Base ini names

bForceReload

force reload the ini file from disk this is required if you make changes to the ini file not using the config system as the hierarchy cache will not be updated in this case

bWriteDestIni

write out a destination ini file to the Saved folder, only valid if bIsBaseIniName is true

bAllowGeneratedIniWhenCooked

If true, the engine will attempt to load the generated/user INI file when loading cooked games

GeneratedConfigDir

The location where generated config files are made.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss