FNameEntry Struct Reference

#include <NameTypes.h>

Public Member Functions
FORCEINLINE bool	IsWide () const
FORCEINLINE int32	GetNameLength () const
CORE_API int32	GetNameLengthUtf8 () const
FORCEINLINE bool	IsNumbered () const
CORE_API void	GetUnterminatedName (TCHAR *OutName, uint32 OutSize) const
CORE_API void	GetName (TCHAR(&OutName)[NAME_SIZE]) const
CORE_API void	GetAnsiName (ANSICHAR(&OutName)[NAME_SIZE]) const
CORE_API void	GetWideName (WIDECHAR(&OutName)[NAME_SIZE]) const
CORE_API FString	GetPlainNameString () const
CORE_API FUtf8String	GetPlainNameUtf8String () const
CORE_API void	AppendNameToString (FWideString &OutString) const
CORE_API void	AppendNameToString (FUtf8String &OutString) const
CORE_API void	AppendNameToString (FWideStringBuilderBase &OutString) const
CORE_API void	AppendNameToString (FUtf8StringBuilderBase &OutString) const
CORE_API void	AppendAnsiNameToString (FAnsiStringBuilderBase &OutString) const
CORE_API void	AppendNameToPathString (FString &OutString) const
CORE_API void	DebugDump (FOutputDevice &Out) const
CORE_API int32	GetSizeInBytes () const
CORE_API void	Write (FArchive &Ar) const
struct CORE_API FNameStringView	MakeView (union FNameBuffer &OptionalDecodeBuffer) const

Static Public Member Functions
static constexpr int32	GetDataOffset ()

Friends
class	FName
struct	FNameHelper
class	FNameEntryAllocator
class	FNamePoolShardBase
class	FNamePool

Detailed Description

A global deduplicated name stored in the global name table.

Member Function Documentation

AppendAnsiNameToString()

void FNameEntry::AppendAnsiNameToString

(

FAnsiStringBuilderBase &

OutString

)

const

Appends name to string builder. Entry must not be wide.

AppendNameToPathString()

void FNameEntry::AppendNameToPathString

(

FString &

OutString

)

const

Appends name to string with path separator using FString::PathAppend().

AppendNameToString() [1/4]

void FNameEntry::AppendNameToString

(

FUtf8String &

OutString

)

const

AppendNameToString() [2/4]

void FNameEntry::AppendNameToString

(

FUtf8StringBuilderBase &

OutString

)

const

AppendNameToString() [3/4]

CORE_API void FNameEntry::AppendNameToString

(

FWideString &

OutString

)

const

Appends name to string. May allocate.

AppendNameToString() [4/4]

void FNameEntry::AppendNameToString

(

FWideStringBuilderBase &

OutString

)

const

Appends name to string builder.

DebugDump()

void FNameEntry::DebugDump

(

FOutputDevice &

Out

)

const

GetAnsiName()

void FNameEntry::GetAnsiName

(

ANSICHAR(&)

OutName[NAME_SIZE]

)

const

Copy null-terminated name to ANSICHAR buffer without allocating. Entry must not be wide.

GetDataOffset()

static constexpr int32 FNameEntry::GetDataOffset ( )

inlinestaticconstexpr

GetName()

void FNameEntry::GetName

(

TCHAR(&)

OutName[NAME_SIZE]

)

const

Copy null-terminated name to TCHAR buffer without allocating.

GetNameLength()

FORCEINLINE int32 FNameEntry::GetNameLength ( ) const

inline

GetNameLengthUtf8()

int32 FNameEntry::GetNameLengthUtf8

(

)

const

GetPlainNameString()

FString FNameEntry::GetPlainNameString

(

)

const

Copy name to a dynamically allocated FString.

GetPlainNameUtf8String()

FUtf8String FNameEntry::GetPlainNameUtf8String

(

)

const

Copy name to a dynamically allocated FString.

GetSizeInBytes()

int32 FNameEntry::GetSizeInBytes

(

)

const

GetUnterminatedName()

void FNameEntry::GetUnterminatedName	(	TCHAR *	OutName,
		uint32	OutSize
	)		const

Copy unterminated name to TCHAR buffer without allocating.

GetWideName()

void FNameEntry::GetWideName

(

WIDECHAR(&)

OutName[NAME_SIZE]

)

const

Copy null-terminated name to WIDECHAR buffer without allocating. Entry must be wide.

IsNumbered()

FORCEINLINE bool FNameEntry::IsNumbered ( ) const

inline

IsWide()

FORCEINLINE bool FNameEntry::IsWide ( ) const

inline

Returns whether this name entry is represented via WIDECHAR or ANSICHAR.

MakeView()

FORCEINLINE FNameStringView FNameEntry::MakeView

(

union FNameBuffer &

OptionalDecodeBuffer

)

const

Write()

void FNameEntry::Write

(

FArchive &

Ar

)

const

Friends And Related Symbol Documentation

FName

friend class FName

friend

FNameEntryAllocator

friend class FNameEntryAllocator

friend

FNameHelper

friend struct FNameHelper

friend

FNamePool

friend class FNamePool

friend

FNamePoolShardBase

friend class FNamePoolShardBase

friend

Member Data Documentation

AnsiName

ANSICHAR FNameEntry::AnsiName[NAME_SIZE]

NameData

uint8 FNameEntry::NameData[0]

NumberedName

FNumberedData FNameEntry::NumberedName

WideName

WIDECHAR FNameEntry::WideName[NAME_SIZE]

---

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

• Engine/Source/Runtime/Core/Public/UObject/NameTypes.h
• Engine/Source/Runtime/Core/Private/UObject/UnrealNames.cpp