PartyLocalUser::GetEntityId

Gets the Entity ID associated with this local user.

Syntax

PartyError GetEntityId(  
    PartyString* entityId  
)  

Parameters

entityId   PartyString*
library-allocated output

The output Entity ID.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

The retrieved Entity ID is identical to the Entity ID provided by the title via PartyManager::CreateLocalUser().

The memory for the Entity ID string remains valid for the life of the local user, which is until its PartyDestroyLocalUserCompletedStateChange has been provided via PartyManager::StartProcessingStateChanges() and all state changes referencing the local user have been returned to PartyManager::FinishProcessingStateChanges().

Requirements

Header: Party.h

See also

PartyLocalUser
PartyManager::CreateLocalUser