FRemoteConfig | Unreal Engine 5.7 Documentation

Manages remote config files.


Name	FRemoteConfig
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Misc/RemoteConfigIni.h
Include Path	#include "Misc/RemoteConfigIni.h"

Syntax

class FRemoteConfig

Name	Remarks	Include Path	Unreal Specifiers
FRemoteConfig()	Constructor	Misc/RemoteConfigIni.h

Name	Type	Remarks	Include Path
bHasCachedFilenames	bool	True if the list of desired remote files has been filled out.	Misc/RemoteConfigIni.h
bIsEnabled	bool	If true, remote ops are allowed.	Misc/RemoteConfigIni.h
CachedFileNames	TArray< FString >	List of desired remote files.	Misc/RemoteConfigIni.h
ConfigBuffers	TMap< FString, FRemoteConfigAsyncIOInfo >	List of remote config file info.	Misc/RemoteConfigIni.h
Timeout	float	Async IO operation timeout.	Misc/RemoteConfigIni.h

Name	Remarks	Include Path
FRemoteConfigAsyncIOInfo * FindConfig ( const TCHAR* Filename )	Simple accessor function.	Misc/RemoteConfigIni.h
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.	Misc/RemoteConfigIni.h
bool IsFinished ( const TCHAR* InFilename )	Returns true if the task has completed.	Misc/RemoteConfigIni.h
bool IsRemoteFile ( const TCHAR* Filename )	Returns true if the specified config file has been flagged as being remote.	Misc/RemoteConfigIni.h
bool Read ( const TCHAR* GeneratedIniFile, const TCHAR* DefaultIniFile )	Queues up a new async task for reading a remote config file.	Misc/RemoteConfigIni.h
bool ShouldReadRemoteFile ( const TCHAR* Filename )	Returns true if the specified file is remote and still needs to be read.	Misc/RemoteConfigIni.h
bool Write ( const TCHAR* Filename, FString& Contents )	Queues up a new async task for writing a remote config file.	Misc/RemoteConfigIni.h

Name	Remarks	Include Path
static void Flush()	Finishes all pending async IO tasks.	Misc/RemoteConfigIni.h
static FRemoteConfig * Get()	Returns a reference to the global FRemoteConfig object.	Misc/RemoteConfigIni.h
static FString ReplaceIniCharWithSpecialChar ( const FString& Str )	Replaces chars used by the ini parser with "special chars".	Misc/RemoteConfigIni.h
static FString ReplaceIniSpecialCharWithChar ( const FString& Str )	Replaces "special chars" that have been inserted to avoid problems with the ini parser with equivalent regular chars.	Misc/RemoteConfigIni.h