FTextFormatString

Type used as a string literal by the text formatter.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/ITextFormatArgumentModifier.h

Include

#include "Internationalization/ITextFormatArgumentModifier.h"

Syntax

class FTextFormatString

Remarks

Type used as a string literal by the text formatter. It is a case sensitive string that can hold onto a string either by pointer (in which case the data being pointed to must outlive this object), or by taking a copy (stored as an FString internally).

The buffer is not guaranteed to be null terminated, so always test the length!

Variables

Name Description

Public variable

int32

 

StringLen

The length of the string

Public variable

const TCHAR *

 

StringPtr

The start of the string

Constructors

Name Description

Public function

FTextFormatString()

Construct an empty string

Public function

FTextFormatString

(
    FString InStr
)

Construct from the given string (steals the value)

Public function

FTextFormatString

(
    const TCHAR* InStr
)

Construct from the given string (takes a copy, expected to be null terminated)

Public function

FTextFormatString

(
    const FTextFormatString& Other
)

Public function

FTextFormatString

(
    FTextFormatString&& Other
)

Functions

Name Description

Public function Static

FTextFormatString

 

MakeReference

(
    const TCHAR* InStr
)

Construct from the given string (takes a reference, expected to be null terminated)

Public function Static

FTextFormatString

 

MakeReference

(
    const TCHAR* InStr,
    const int32 InLen
)

Construct from the given pointer and size (takes a sub-string reference, doesn't have to be null terminated)

Operators

Name Description

Public function

FTextFormatString &

 

operator=

(
    const FTextFormatString& Other
)

Public function

FTextFormatString &

 

operator=

(
    FTextFormatString&& Other
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback