xboxlive_stats_remove_user


Description

This function can be used to remove (unregister) a given user from the statistics manager, performing a flush of the stat data to the live server. According to the XBox documentation the game does not have to remove the user from the stats manager, as the XBox OS will periodically flush the stats anyway. You supply the user ID as returned by (for example) the function xboxlive_get_user(), and the function will will return -1 if there was an error or if the user ID is invalid, or any other value if the function was successfully called.

NOTE: Removing the user can return an error if the statistics that have been set on the user are invalid (such as the stat names containing non-alpha numeric characters).


The function will generate a callback which will trigger a System Asynchronous Event. This event will have the special DS map async_load which should then be parsed for the following keys:

  • "id" - Will hold the constant achievement_stat_event

  • "eventname" - Will hold the string "LocalUserRemoved"

  • "userid" - The user ID associated with the request

  • "error" - 0 if successful, some other value if there has been an error

  • "errormessage" - A string with an error message, if any is available

Note that if you want to flush the stats data to the live server at any time without removing the user, you can use the function xboxlive_stats_flush_user().

IMPORTANT! This function is only valid when exporting using the UWP target for the Xbox One and it requires you to have checked the Enable XBox Live option in the UWP Game Options.


Syntax:

xboxlive_stats_remove_user(user_id);

Argument Description
user_id The user ID (a pointer) to remove


Returns:

Real


Example:

for(var i = 0; i < xboxlive_get_user_count(); ++i;)
    {
    user_id[i] = xboxlive_get_user(i);
    xboxlive_stats_remove_user(user_id[i]);
    }

The above code loop through the stored user account IDs and remove (unregister) each user from the stats manager.