FTextStringHelper::ReadFromBuffer

Attempt to extract an [FText](API\Runtime\Core\Internationalization\FText) instance from the given stream of text.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Internationalization/Text.h"

Source

/Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp

Syntax

static const TCHAR * ReadFromBuffer
(
    const TCHAR * Buffer,
    FText & OutValue,
    const TCHAR * TextNamespace,
    const TCHAR * PackageNamespace,
    const bool bRequiresQuotes
)

Remarks

Attempt to extract an FText instance from the given stream of text.

Returns

The updated buffer after we parsed this text, or nullptr on failure

Parameters

Parameter

Description

Buffer

The buffer of text to read from (null terminated).

OutValue

The text value to fill with the read text.

TextNamespace

An optional namespace to use when parsing texts that use LOCTEXT (default is an empty namespace).

PackageNamespace

The package namespace of the containing object (if loading for a property - see TextNamespaceUtil::GetPackageNamespace).

bRequiresQuotes

True if the read text literal must be surrounded by quotes (eg, when loading from a delimited list).
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss