PFFriendsServerGetFriendsListAsync - XBOX Game Development Documentation

Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services’ friends.

Syntax

HRESULT PFFriendsServerGetFriendsListAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFFriendsServerGetFriendsListRequest* request,  
    XAsyncBlock* async  
)  

Parameters

titleEntityHandle PFEntityHandle PFEntityHandle for a title Entity obtained using PFAuthenticationGetEntityWithSecretKeyAsync. request PFFriendsServerGetFriendsListRequest* Populated request object. async XAsyncBlock*
Inout XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on Win32, Linux, and macOS. See also ServerAddFriendAsync, ServerGetPlayerProfileAsync, ServerRemoveFriendAsync, ServerSetFriendTagsAsync. When the asynchronous task is complete, call PFFriendsServerGetFriendsListGetResultSize and PFFriendsServerGetFriendsListGetResult to get the result.

Requirements

Header: PFFriends.h

See also

PFFriends members

Last modified on August 3, 2026

⌘I