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

Light Theme

Dark Theme

FRemoteConfig

Manages remote config files.

Windows

MacOS

Linux

References

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

Syntax

class FRemoteConfig

Remarks

Manages remote config files.

Constructors

	Name	Description
	FRemoteConfig()	Constructor

Functions

	Name	Description
FRemoteConfi...	FindConfig ( const TCHAR* Filename )	Simple accessor function.
void	FinishRead ( const TCHAR* Filename )	Waits on the async read if it hasn't finished yet... times out if the operation has taken too long.
void	Flush()	Finishes all pending async IO tasks.
FRemoteConfi...	Get()	Returns a reference to the global FRemoteConfig object.
bool	IsFinished ( const TCHAR* InFilename )	Returns true if the task has completed.
bool	IsRemoteFile ( const TCHAR* Filename )	Returns true if the specified config file has been flagged as being remote.
bool	Read ( const TCHAR* GeneratedIniFile, const TCHAR* DefaultIniFile )	Queues up a new async task for reading a remote config file.
FString	ReplaceIniCharWithSpecialChar ( const FString& Str )	Replaces chars used by the ini parser with "special chars".
FString	ReplaceIniSpecialCharWithChar ( const FString& Str )	Replaces "special chars" that have been inserted to avoid problems with the ini parser with equivalent regular chars.
bool	ShouldReadRemoteFile ( const TCHAR* Filename )	Returns true if the specified file is remote and still needs to be read.
bool	Write ( const TCHAR* Filename, FString& Contents )	Queues up a new async task for writing a remote config file.

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

Take our survey

Dismiss