EOS API reference page for EOS_Presence_SetPresence

This function is part of the Presence Interface.


Sets your new presence with the data applied to a PresenceModificationHandle. The PresenceModificationHandle can be released safely after calling this function.

See Also

EOS_Presence_CreatePresenceModification, EOS_PresenceModification_Release


Parameter Type And Name

Usage Information

EOS_HPresence Handle

const EOS_Presence_SetPresenceOptions* Options

Object containing a PresenceModificationHandle and associated user data

void* ClientData

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

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

Callback Remarks

Callback for information related to EOS_Presence_SetPresence finishing.

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Presence_SetPresenceCallbackInfo* Data

Related API Members