Edit

Share via

PartyChatControl::GetEntityId

  • Article

Gets the PlayFab Entity ID of the user associated with this chat control.

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 memory for the Entity ID string remains valid for the life of the chat control, which is until its PartyChatControlDestroyedStateChange and/or PartyDestroyChatControlCompletedStateChange, depending on the type of destruction that occurred, has been provided via PartyManager::StartProcessingStateChanges() and all state changes referencing the chat control have been returned to PartyManager::FinishProcessingStateChanges().

Requirements

Header: Party.h

See also

PartyChatControl