> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PartyLocalUser::GetEntityId

> 取得與此本機使用者相關聯的 PlayFab 實體識別碼。

取得與此本機使用者相關聯的 PlayFab 實體識別碼。

## 語法

```cpp theme={null}
PartyError GetEntityId(  
    PartyString* entityId  
)  
```

### 參數

**`entityId`**   [PartyString\*](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/typedefs.md)\
*library-allocated output*

使用者的輸出實體識別碼。

### 傳回值

PartyError

`c_partyErrorSuccess` (如果呼叫成功)，否則為錯誤碼。可透過 [PartyManager::GetErrorMessage()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md) 擷取錯誤碼的人類可讀形式。

## 備註

擷取的 PlayFab 實體識別碼與遊戲透過 [PartyManager::CreateLocalUser()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md) 或 [PartyManager::CreateLocalUserWithEntityType()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md) 提供的實體識別碼相同。這也與代表該實體之 `PFEntityKey` 結構的 *id* 欄位中的值相同。[GetEntityType()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentitytype.md) 傳回的值則代表 `PFEntityKey` 的另一半。 \
\
 實體識別碼字串的記憶體在本機使用者的存留期間內保持有效，也就是直到 [PartyManager::StartProcessingStateChanges()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges.md) 提供其 [PartyDestroyLocalUserCompletedStateChange](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/structs/partydestroylocalusercompletedstatechange.md)，且所有參考該本機使用者的狀態變更都已傳回給 [PartyManager::FinishProcessingStateChanges()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_finishprocessingstatechanges.md) 為止。

## 需求

**標頭：** Party.h

## 另請參閱

[PartyLocalUser](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/partylocaluser.md)\
[PartyLocalUser::GetEntityType](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentitytype.md)\
[PartyManager::CreateLocalUser](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md)\
[PartyManager::CreateLocalUserWithEntityType](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md)


## Related topics

- [PartyLocalUser::GetEntityType](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentitytype.md)
- [PartyLocalUser::UpdateEntityToken](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_updateentitytoken.md)
- [PartyEndpoint::GetEntityId](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentityid.md)
- [PartyChatControl::GetEntityId](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentityid.md)
- [PartyLocalUser::GetCustomContext](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getcustomcontext.md)