EOS API reference page for EOS_Presence_CopyPresence

This function is part of the Presence Interface.


Get a user's cached presence object. If successful, this data must be released by calling EOS_Presence_Info_Release

Return Value

Success if we have cached data, or an error result if the request was invalid or we do not have cached data.

See Also



Parameter Type And Name

Usage Information

EOS_HPresence Handle

const EOS_Presence_CopyPresenceOptions* Options

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

EOS_Presence_Info** OutPresence

A pointer to a pointer of Presence Info. If the returned result is success, this will be set to data that must be later released, otherwise this will be set to NULL

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members