Edit

PartyDestroyLocalUserCompletedStateChange

  • Article

Information specific to the DestroyLocalUserCompleted type of state change.

Syntax

struct PartyDestroyLocalUserCompletedStateChange : PartyStateChange {  
    PartyStateChangeResult result;  
    PartyError errorDetail;  
    PartyLocalUser* localUser;  
    void* asyncIdentifier;  
}

Members

result   PartyStateChangeResult

Indicates that the destroy local user operation Succeeded or provides the reason that it failed.

errorDetail   PartyError

A diagnostic value providing additional troubleshooting information regarding any potential error condition.

The human-readable form of this error detail can be retrieved via PartyManager::GetErrorMessage().

localUser   PartyLocalUser*

The local user provided to the call associated with this state change.

asyncIdentifier   void*

The async identifier provided to the call associated with this state change.

Remarks

This PartyLocalUser will be removed from all dependent networks prior to this state change. All dependent PartyEndpoint and PartyChatControl objects will be destroyed with reason PartyDestroyedReason::UserRemoved prior to the PartyLocalUser being removed from its dependent networks. Once this state change is returned to PartyManager::FinishProcessingStateChanges(), the PartyLocalUser object memory will become invalid.

Requirements

Header: Party.h

See also

Party members
PartyManager::DestroyLocalUser