EOS API reference page for EOS_Presence_QueryPresence

This function is part of the Presence Interface.


Query a user's presence. This must complete successfully before CopyPresence will have valid results. If HasPresence returns true for a remote user, this does not need to be called.


Parameter Type And Name

Usage Information

EOS_HPresence Handle

const EOS_Presence_QueryPresenceOptions* Options

Object containing properties related to who is querying presence and for what user

void* ClientData

Optional pointer to help track this request, that is returned in the completion callback

const EOS_Presence_OnQueryPresenceCompleteCallback CompletionDelegate

Pointer to a function that handles receiving the completion information

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_Presence_OnQueryPresenceCompleteCallback to report the results of its operation.

Callback Remarks

Callback for information related to EOS_Presence_QueryPresence finishing.

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Presence_QueryPresenceCallbackInfo* Data

Related API Members