FRemoteConfig Class Reference

#include <RemoteConfigIni.h>

Public Member Functions
	FRemoteConfig ()
bool	IsRemoteFile (const TCHAR *Filename)
bool	ShouldReadRemoteFile (const TCHAR *Filename)
FRemoteConfigAsyncIOInfo *	FindConfig (const TCHAR *Filename)
bool	IsFinished (const TCHAR *InFilename)
bool	Read (const TCHAR *GeneratedIniFile, const TCHAR *DefaultIniFile)
bool	Write (const TCHAR *Filename, FString &Contents)
void	FinishRead (const TCHAR *Filename)

Static Public Member Functions
static FRemoteConfig *	Get ()
static CORE_API void	Flush ()
static CORE_API FString	ReplaceIniCharWithSpecialChar (const FString &Str)
static CORE_API FString	ReplaceIniSpecialCharWithChar (const FString &Str)

Detailed Description

Manages remote config files.

Constructor & Destructor Documentation

FRemoteConfig()

FRemoteConfig::FRemoteConfig

(

)

Constructor

Member Function Documentation

FindConfig()

FRemoteConfigAsyncIOInfo * FRemoteConfig::FindConfig

(

const TCHAR *

Filename

)

Simple accessor function.

FinishRead()

void FRemoteConfig::FinishRead

(

const TCHAR *

Filename

)

Waits on the async read if it hasn't finished yet... times out if the operation has taken too long.

Flush()

void FRemoteConfig::Flush ( )

static

Finishes all pending async IO tasks.

Get()

FRemoteConfig * FRemoteConfig::Get ( )

static

Returns a reference to the global FRemoteConfig object.

IsFinished()

bool FRemoteConfig::IsFinished

(

const TCHAR *

InFilename

)

Returns true if the task has completed.

IsRemoteFile()

bool FRemoteConfig::IsRemoteFile

(

const TCHAR *

Filename

)

Returns true if the specified config file has been flagged as being remote.

Read()

bool FRemoteConfig::Read	(	const TCHAR *	GeneratedIniFile,
		const TCHAR *	DefaultIniFile
	)

Queues up a new async task for reading a remote config file.

ReplaceIniCharWithSpecialChar()

FString FRemoteConfig::ReplaceIniCharWithSpecialChar ( const FString &  Str )

static

ReplaceIniSpecialCharWithChar()

FString FRemoteConfig::ReplaceIniSpecialCharWithChar ( const FString &  Str )

static

ShouldReadRemoteFile()

bool FRemoteConfig::ShouldReadRemoteFile

(

const TCHAR *

Filename

)

Returns true if the specified file is remote and still needs to be read.

Write()

bool FRemoteConfig::Write	(	const TCHAR *	Filename,
		FString &	Contents
	)

Queues up a new async task for writing a remote config file.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Misc/RemoteConfigIni.h
• Engine/Source/Runtime/Core/Private/Misc/RemoteConfigIni.cpp