Navigation
API > API/Runtime > API/Runtime/Core
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!
| Name | FTextFormatString |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/ITextFormatArgumentModifier.h |
| Include Path | #include "Internationalization/ITextFormatArgumentModifier.h" |
Syntax
class FTextFormatString
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Construct an empty string | Internationalization/ITextFormatArgumentModifier.h | ||
FTextFormatString
(
FString InStr |
Construct from the given string (steals the value) | Internationalization/ITextFormatArgumentModifier.h | |
FTextFormatString
(
const TCHAR* InStr |
Construct from the given string (takes a copy, expected to be null terminated) | Internationalization/ITextFormatArgumentModifier.h | |
FTextFormatString
(
const FTextFormatString& Other |
Internationalization/ITextFormatArgumentModifier.h | ||
FTextFormatString
(
FTextFormatString&& Other |
Internationalization/ITextFormatArgumentModifier.h | ||
FTextFormatString
(
const TCHAR* InStr, |
Construct from the given pointer and size (takes a sub-string reference, doesn't have to be null terminated) | Internationalization/ITextFormatArgumentModifier.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| StringLen | int32 | The length of the string | Internationalization/ITextFormatArgumentModifier.h | |
| StringPtr | const TCHAR * | The start of the string | Internationalization/ITextFormatArgumentModifier.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InternalString | FString | Internal copy if constructed from a string | Internationalization/ITextFormatArgumentModifier.h |
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FTextFormatString MakeReference
(
const TCHAR* InStr |
Construct from the given string (takes a reference, expected to be null terminated) | Internationalization/ITextFormatArgumentModifier.h | |
static FTextFormatString MakeReference
(
const TCHAR* InStr, |
Construct from the given pointer and size (takes a sub-string reference, doesn't have to be null terminated) | Internationalization/ITextFormatArgumentModifier.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTextFormatString & operator=
(
const FTextFormatString& Other |
Internationalization/ITextFormatArgumentModifier.h | ||
FTextFormatString & operator=
(
FTextFormatString&& Other |
Internationalization/ITextFormatArgumentModifier.h |