Edit

Share via

PartyRemoveLocalUserCompletedStateChange

  • Article

Information specific to the RemoveLocalUserCompleted type of state change.

Syntax

struct PartyRemoveLocalUserCompletedStateChange : PartyStateChange {  
    PartyStateChangeResult result;  
    PartyError errorDetail;  
    PartyNetwork* network;  
    PartyLocalUser* localUser;  
    void* asyncIdentifier;  
}

Members

result   PartyStateChangeResult

Indicates that the remove 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().

network   PartyNetwork*

The network used in the call associated with this state change.

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

All PartyEndpoints and PartyChatControls depending upon this user will have been destroyed with reason PartyDestroyedReason::UserRemoved before this state change is generated. If the user referenced by this state change was the last authenticated user in the network, then all remaining PartyEndpoints on this device, which at this point inherently consists of only endpoints associated with the last user or no user, will also have been destroyed before this state change is generated. An associated PartyLocalUserRemovedStateChange will have been generated before this state change is generated.

Requirements

Header: Party.h

See also

Party members
PartyChatControlDestroyedStateChange
PartyChatControlLeftNetworkStateChange
PartyEndpointDestroyedStateChange
PartyNetwork::RemoveLocalUser