User File Interface

The Online Services User File Interface provides support for your game to read user-specific files from your platform's backend online services at runtime.

Your game might require you to read user files that are not packaged with your title. Examples may include configuration files or user-specific game save files. This interface helps you to access and download these files for use at runtime.

For title-specific file storage, see the Title File Interface.

API Overview

Functions

The following table provides a high-level overview of the functions provided by the User File Interface:

Process Flow for Reading Files

To read, copy, or delete a file from the backend online services with the User File Interface, follow these steps:

1. EnumerateFiles caches a list of all files available to retrieve from the online services with the interface.

2. GetEnumeratedFiles retrieves the list of files cached with the interface by EnumerateFiles.

3. For each file in the retrieved list, ReadFile reads the file and returns its contents.

Modifying Files

The User File Interface also supports operations for modifying files:

• WriteFile creates new files or overwrites existing ones.

• CopyFile copies the contents of a user file to a different user file.

• DeleteFile deletes the user file with the provided name from the backend online services.

More Information

Header File

Consult the UserFile.h header file directly for more information as needed. The User File Interface header file UserFile.h is located in the directory:

Engine\Plugins\Online\OnlineServices\Source\OnlineServicesInterface\Public\Online

For instructions on how to obtain the UE source code, see our documentation on Downloading Unreal Engine Source Code.

Function Parameters and Return Types

See the Functions section of the Online Services Overview page for an explanation of function parameters and return types, including how to pass parameters and processing the results when functions return.