FURL Struct Reference

#include <EngineBaseTypes.h>

Public Member Functions
	FURL (ENoInit)
ENGINE_API	FURL (const TCHAR *Filename=nullptr)
ENGINE_API	FURL (FURL *Base, const TCHAR *TextURL, ETravelType Type)
ENGINE_API bool	IsInternal () const
ENGINE_API bool	IsLocalInternal () const
ENGINE_API bool	HasOption (const TCHAR *Test) const
ENGINE_API const TCHAR *	GetOption (const TCHAR *Match, const TCHAR *Default) const
ENGINE_API void	LoadURLConfig (const TCHAR *Section, const FString &Filename=GGameIni)
ENGINE_API void	SaveURLConfig (const TCHAR *Section, const TCHAR *Item, const FString &Filename=GGameIni) const
ENGINE_API void	AddOption (const TCHAR *Str)
ENGINE_API void	RemoveOption (const TCHAR *Key, const TCHAR *Section=nullptr, const FString &Filename=GGameIni)
ENGINE_API FString	ToString (bool FullyQualified=0) const
ENGINE_API FString	GetHostPortString () const
ENGINE_API bool	operator== (const FURL &Other) const

Static Public Member Functions
static ENGINE_API void	StaticInit ()
static ENGINE_API void	StaticExit ()
static ENGINE_API void	FilterURLString (FString &Str)

Public Attributes
FString	Protocol
FString	Host
int32	Port
int32	Valid
FString	Map
FString	RedirectURL
TArray< FString >	Op
FString	Portal

Static Public Attributes
static ENGINE_API FUrlConfig	UrlConfig
static ENGINE_API bool	bDefaultsInitialized =false

Friends
ENGINE_API friend FArchive &	operator<< (FArchive &Ar, FURL &U)

Constructor & Destructor Documentation

FURL() [1/3]

FURL::FURL ( ENoInit  )

inlineexplicit

Prevent default from being generated.

FURL() [2/3]

FURL::FURL

(

const TCHAR *

Filename = nullptr

)

Construct a purely default, local URL from an optional filename.

FURL() [3/3]

FURL::FURL	(	FURL *	Base,
		const TCHAR *	TextURL,
		ETravelType	Type
	)

Construct a URL from text and an optional relative base.

Member Function Documentation

AddOption()

void FURL::AddOption

(

const TCHAR *

Str

)

Add a unique option to the URL, replacing any existing one.

FilterURLString()

void FURL::FilterURLString ( FString &  Str )

static

Static: Removes any special URL characters from the specified string

Parameters

Str	String to be filtered

GetHostPortString()

FString FURL::GetHostPortString

(

)

const

Prepares the Host and Port values into a standards compliant string

GetOption()

const TCHAR * FURL::GetOption	(	const TCHAR *	Match,
		const TCHAR *	Default
	)		const

Returns the value associated with an option.

Parameters

Match	The name of the option to get.
Default	The value to return if the option wasn't found.

Returns

The value of the named option, or Default if the option wasn't found.

HasOption()

bool FURL::HasOption

(

const TCHAR *

Test

)

const

Tests if the URL contains an option string.

IsInternal()

bool FURL::IsInternal

(

)

const

Returns whether this URL corresponds to an internal object, i.e. an Unreal level which this app can try to connect to locally or on the net. If this is false, the URL refers to an object that a remote application like Internet Explorer can execute.

IsLocalInternal()

bool FURL::IsLocalInternal

(

)

const

Returns whether this URL corresponds to an internal object on this local process. In this case, no Internet use is necessary.

LoadURLConfig()

void FURL::LoadURLConfig	(	const TCHAR *	Section,
		const FString &	Filename = GGameIni
	)

Load URL from config.

operator==()

bool FURL::operator==

(

const FURL &

Other

)

const

Compare two URLs to see if they refer to the same exact thing.

RemoveOption()

void FURL::RemoveOption	(	const TCHAR *	Key,
		const TCHAR *	Section = nullptr,
		const FString &	Filename = GGameIni
	)

Remove an option from the URL

SaveURLConfig()

void FURL::SaveURLConfig	(	const TCHAR *	Section,
		const TCHAR *	Item,
		const FString &	Filename = GGameIni
	)		const

Save URL to config.

StaticExit()

void FURL::StaticExit ( )

static

StaticInit()

void FURL::StaticInit ( )

static

ToString()

FString FURL::ToString

(

bool

FullyQualified = 0

)

const

Convert this URL to text.

Friends And Related Symbol Documentation

operator<<

ENGINE_API friend FArchive & operator<< ( FArchive &  Ar, FURL &  U  )

friend

Serializes a FURL to or from an archive.

Member Data Documentation

bDefaultsInitialized

bool FURL::bDefaultsInitialized =false

static

Host

FString FURL::Host

Map

FString FURL::Map

Op

TArray<FString> FURL::Op

Port

int32 FURL::Port

Portal

FString FURL::Portal

Protocol

FString FURL::Protocol

RedirectURL

FString FURL::RedirectURL

UrlConfig

FUrlConfig FURL::UrlConfig

static

Valid

int32 FURL::Valid

---

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

• Engine/Source/Runtime/Engine/Classes/Engine/EngineBaseTypes.h
• Engine/Source/Runtime/Engine/Private/URL.cpp