gpDeleteProfile

GameSpy SDK

gpDeleteProfile

This function deletes the local profile. Note that this is a blocking call.

GPResult gpDeleteProfile(
GPConnection * connection,
GPCallback callback,
void * arg );
RoutineRequired HeaderDistribution
gpDeleteProfile<gp.h>SDKZIP

Return Value

This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.

Parameters

connection
[in] A GP connection interface with an established connection.
callback
[in] The callback used to confirm the deleted profile
arg
[in] User data

Remarks

This function deletes the local profile. Because the connection is between the local profile and the server, this automatically ends this connection (gpDisconnect does not need to be called). There is no way to delete any profile other than the current connected profile. The operation will fail if the connected profile is the user’s only profile. A successful delete will result in the callback getting called. The callback will have the data about the delete profile and whether it was successful or not.

Section Reference: Gamespy Presence SDK