EOS API reference page for EOS_Friends_QueryFriends

This function is part of the Friends Interface.


Starts an asynchronous task that reads the user's friends list from the backend service, caching it for future use.

When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).


Parameter Type And Name

Usage Information

EOS_HFriends Handle

const EOS_Friends_QueryFriendsOptions* Options

structure containing the account for which to retrieve the friends list

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Friends_OnQueryFriendsCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Friends_OnQueryFriendsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Friends_QueryFriends

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Friends_QueryFriendsCallbackInfo* Data

A EOS_Friends_QueryFriendsCallbackInfo containing the output information and result

Related API Members