Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Gets the PlayFab Entity ID of the user associated with this endpoint.
Syntax
PartyError GetEntityId(
PartyString* entityId
)
Parameters
entityId PartyString*
library-allocated output, may return nullptr
The output Entity ID of the user associated with this endpoint, or nullptr.
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 returned string is the same value as the one found in the ID field of a PFEntityKey structure representing the entity. The value returned from GetEntityType() would represent the other half of a PFEntityKey.
If this endpoint isn't associated with a user, entityId is set to nullptr.
The memory for the Entity ID string remains valid for the life of the endpoint, which is until its PartyEndpointDestroyedStateChange and/or PartyDestroyEndpointCompletedStateChange, depending on the type of destruction that occurred, has been provided via PartyManager::StartProcessingStateChanges() and all state changes referencing the endpoint have been returned to PartyManager::FinishProcessingStateChanges().
Requirements
Header: Party.h