Edit

PartyManager::DestroyLocalUser

  • Article

Starts an asynchronous operation to destroy a local user.

Syntax

PartyError DestroyLocalUser(  
    const PartyLocalUser* localUser,  
    void* asyncIdentifier  
)

Parameters

localUser   PartyLocalUser*

The local user to destroy.

asyncIdentifier   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

Return value

PartyError

c_partyErrorSuccess if the operation to destroy the local user started or an error code otherwise. If this method fails, no related state changes will be generated. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

This method queues an asynchronous operation to destroy a local user. A PartyDestroyLocalUserCompletedStateChange will be provided upon completion of the operation, indicating success or failure. Before successful completion of the operation, the local user will be removed from all networks it has authenticated into (each indicated by a PartyLocalUserRemovedStateChange) and any local chat control associated with the user will be destroyed (indicated by a PartyChatControlDestroyedStateChange). Memory for the local user will remain valid until all state changes referencing the local user have been returned to PartyManager::FinishProcessingStateChanges().

Requirements

Header: Party.h

See also

PartyManager
PartyDestroyLocalUserCompletedStateChange
PartyChatControlDestroyedStateChange
PartyLocalUserRemovedStateChange
PartyManager::GetLocalUsers