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

IOnlineFriends::ReadFriendsList

Starts an async task that reads the named friends list for the player

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineFriendsInterface.h
Include	#include "Interfaces/OnlineFriendsInterface.h"

Syntax

bool ReadFriendsList
(
    int32 LocalUserNum,
    const FString & ListName,
    const FOnReadFriendsListComplete & Delegate
)

Remarks

Starts an async task that reads the named friends list for the player

Returns

true if the read request was started successfully, false otherwise

Parameters

Parameter	Description
LocalUserNum	the user to read the friends list of
ListName	name of the friends list to read

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

Take our survey

Dismiss