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

Light Theme

Dark Theme

FLocTextHelper::LoadForeignArchive

Attempt to load (or create) a foreign archive file from the given file path.

Windows

MacOS

Linux

References

Module	Localization
Header	/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Include	#include "LocTextHelper.h"
Source	/Engine/Source/Developer/Localization/Private/LocTextHelper.cpp

Syntax

bool LoadForeignArchive
(
    const FString & InCulture,
    const FString & InArchiveFilePath,
    const ELocTextHelperLoadFlags InLoadFlags,
    FText * OutError
)

Remarks

Attempt to load (or create) a foreign archive file from the given file path.

This requires that the given culture is in the list of foreign cultures set during construction.

The manifest and native archive (if set) must have been loaded prior to loading foreign archives.

Returns

True if the file was loaded (or created), false otherwise.

Parameters

Parameter	Description
InCulture	Culture code of the archive to load.
InArchiveFilePath	Full file path to load the archive from.
InLoadFlags	Flags controlling whether we should load or create the archive file.
OutError	Optional text to be filled when an error occurs.

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

Take our survey

Dismiss