> ## 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.

# PartyChatControl::GetEntityId

> 获取与此聊天控件关联的用户的 PlayFab 实体 ID。

获取与此聊天控件关联的用户的 PlayFab 实体 ID。

## 语法

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

### 参数

**`entityId`**   [PartyString\*](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/typedefs.md)
*由库分配的输出*

输出的 Entity ID。

### 返回值

PartyError

如果调用成功,则返回 `c_partyErrorSuccess`;否则返回错误代码。可以通过 [PartyManager::GetErrorMessage()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md) 检索错误代码的人类可读形式。

## 备注

返回的字符串与表示该实体的 `PFEntityKey` 结构的 *id* 字段中的值相同。[GetEntityType()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentitytype.md) 返回的值表示 `PFEntityKey` 的另一半。\
\
 Entity ID 字符串的内存在聊天控件的整个生命周期内保持有效,即在通过 [PartyManager::StartProcessingStateChanges()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges.md) 提供其 [PartyChatControlDestroyedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partychatcontroldestroyedstatechange.md) 和/或 [PartyDestroyChatControlCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partydestroychatcontrolcompletedstatechange.md)(具体取决于发生的销毁类型),并且所有引用该聊天控件的状态更改都返回给 [PartyManager::FinishProcessingStateChanges()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_finishprocessingstatechanges.md) 之前有效。

## 要求

\*\*头文件:\*\*Party.h

## 另请参阅

[PartyChatControl](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/partychatcontrol.md)
[PartyChatControl::GetEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentitytype.md)


## Related topics

- [PartyChatControl::GetEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentitytype.md)
- [PartyChatControl::GetNetworks](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getnetworks.md)
- [PartyChatControl::GetLocal](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getlocal.md)
- [PartyChatControl::GetDevice](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getdevice.md)
- [PartyChatControl::GetCustomContext](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getcustomcontext.md)