Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Internationalization > FTextFormatString

Light Theme

Dark Theme

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). @note The buffer is not guaranteed to be null terminated, so always test the length!

Variables

		Name	Description
	int32	StringLen	The length of the string
	const TCHAR ...	StringPtr	The start of the string

Constructors

	Name	Description
	FTextFormatString()	Construct an empty string
	FTextFormatString ( FString InStr )	Construct from the given string (steals the value)
	FTextFormatString ( const TCHAR* InStr )	Construct from the given string (takes a copy, expected to be null terminated)
	FTextFormatString ( const FTextFormatString& Other )
	FTextFormatString ( FTextFormatString&& Other )

Functions

		Name	Description
	FTextFormatS...	MakeReference ( const TCHAR* InStr )	Construct from the given string (takes a reference, expected to be null terminated)
	FTextFormatS...	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
	FTextFormatS...	operator= ( const FTextFormatString& Other )
	FTextFormatS...	operator= ( FTextFormatString&& Other )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss