PFFriendsClientGetFriendsListAsync - XBOX Game Development Documentation

Retrieves the current friend list for the local user, 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 PFFriendsClientGetFriendsListAsync(  
    PFEntityHandle entityHandle,  
    const PFFriendsClientGetFriendsListRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFFriendsClientGetFriendsListRequest* 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 all platforms. See also ClientAddFriendAsync, ClientGetPlayerProfileAsync, ClientRemoveFriendAsync. When the asynchronous task is complete, call PFFriendsClientGetFriendsListGetResultSize and PFFriendsClientGetFriendsListGetResult to get the result.

Requirements

Header: PFFriends.h

See also

PFFriends members

Last modified on August 3, 2026

Related topics

PFFriendsClientGetFriendsListGetResult Services C API overview - PFFriends.h PFFriendsClientAddFriendAsync PFFriendsClientSetFriendTagsAsync PFFriendsClientGetFriendsListGetResultSize

⌘I