FGuid

Implements a globally unique identifier.

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Guid.h

Include

#include "Misc/Guid.h"

Syntax

struct FGuid

Remarks

Implements a globally unique identifier.

Variables

Name Description

Public variable

uint32

 

A

Private:

Public variable

uint32

 

B

Holds the second component.

Public variable

uint32

 

C

Holds the third component.

Public variable

uint32

 

D

Holds the fourth component.

Constructors

Name Description

Public function

FGuid()

Default constructor.

Public function

FGuid

(
    const FString& InGuidStr
)

Public function

FGuid

(
    uint32 InA,
    uint32 InB,
    uint32 InC,
    uint32 InD
)

Creates and initializes a new GUID from the specified components.

Functions

Name Description

Public function Const

void

 

AppendString

(
    FAnsiStringBuilderBase& Builder,
    EGuidFormats Format
)

Appends this GUID to the string builder using the specified format.

Public function Const

void

 

AppendString

(
    FWideStringBuilderBase& Builder,
    EGuidFormats Format
)

Converts this GUID to its string representation using the specified format.

Public function Const

void

 

AppendString

(
    FUtf8StringBuilderBase& Builder,
    EGuidFormats Format
)

Converts this GUID to its string representation using the specified format.

Public function Const

void

 

AppendString

(
    FString& Out,
    EGuidFormats Format
)

Converts this GUID to its string representation using the specified format.

Public function Const

bool

 

ExportTextItem

(
    FString& ValueStr,
    FGuid const& DefaultValue,
    UObject* Parent,
    int32 PortFlags,
    UObject* ExportRootScope
)

Exports the GUIDs value to a string.

Public function

bool

 

ImportTextItem

(
    const TCHAR*& Buffer,
    int32 PortFlags,
    UObject* Parent,
    FOutputDevice* ErrorText
)

Imports the GUIDs value from a text buffer.

Public function

void

 

Invalidate()

Invalidates the GUID.

Public function Const

bool

 

IsValid()

Checks whether this GUID is valid or not.

Public function Static

FGuid

 

NewGuid()

Returns a new GUID.

Public function Static

bool

 

Parse

(
    const FString& GuidString,
    FGuid& OutGuid
)

Converts a string to a GUID.

Public function Static

bool

 

ParseExact

(
    const FString& GuidString,
    EGuidFormats Format,
    FGuid& OutGuid
)

Converts a string with the specified format to a GUID.

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Public function

bool

 

Serialize

(
    FStructuredArchive::FSlot Slot
)

Public function Const

FString

 

ToString

(
    EGuidFormats Format
)

Converts this GUID to its string representation.

Operators

Name Description

Public function

uint32 &

 

operator[]

(
    int32 Index
)

Provides access to the GUIDs components.

Public function Const

const uint32...

 

operator[]

(
    int32 Index
)

Provides read-only access to the GUIDs components.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel