PartyLocalUser::GetEntityId

このローカル ユーザーに関連付けられている PlayFab エンティティ ID を取得します。

構文

PartyError GetEntityId(  
    PartyString* entityId  
)  

パラメーター

entityId PartyString*
ライブラリに割り当てられた出力

ユーザーの出力エンティティ ID。

戻り値

PartyError

呼び出しが成功した場合は c_partyErrorSuccess、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。

解説

取得した PlayFab エンティティ ID は、PartyManager::CreateLocalUser() または PartyManager::CreateLocalUserWithEntityType() を介してタイトルによって提供されるエンティティ ID と同じです。 これは、エンティティを表す PFEntityKey 構造体の ID フィールドにある値と同じ値でもあります。 GetEntityType() から返される値は、PFEntityKey の残りの半分を表します。

エンティティ ID 文字列のメモリはローカル ユーザーの有効期間中には有効なままです。これは、その PartyDestroyLocalUserCompletedStateChangePartyManager::StartProcessingStateChanges() を介して提供され、そのローカル ユーザーを参照しているすべての状態変更が PartyManager::FinishProcessingStateChanges() に返されるまでです。

要件

ヘッダー: Party.h

関連項目

PartyLocalUser
PartyLocalUser::GetEntityType
PartyManager::CreateLocalUser
PartyManager::CreateLocalUserWithEntityType