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

# PartyEndpoint::GetEntityId

> 获取与此终结点关联的用户的 PlayFab 实体 ID。

获取与此终结点关联的用户的 PlayFab 实体 ID。

## Syntax

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

### Parameters

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

与此终结点关联的用户的输出 Entity ID，或 nullptr。

### Return value

PartyError

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

## Remarks

返回的字符串与表示该实体的 `PFEntityKey` 结构中的 *ID* 字段中找到的值相同。[GetEntityType()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentitytype.md) 返回的值将表示 `PFEntityKey` 的另一半。\
\
 如果此终结点未与用户关联，`entityId` 将被设置为 nullptr。  \
\
 Entity ID 字符串的内存在终结点的生命周期内保持有效，即在其 [PartyEndpointDestroyedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partyendpointdestroyedstatechange.md) 和/或 [PartyDestroyEndpointCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partydestroyendpointcompletedstatechange.md)（取决于所发生的销毁类型）已通过 [PartyManager::StartProcessingStateChanges()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges.md) 提供并且所有引用该终结点的状态更改已返回到 [PartyManager::FinishProcessingStateChanges()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_finishprocessingstatechanges.md) 之前。

## Requirements

**Header:** Party.h

## See also

[PartyEndpoint](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/partyendpoint.md)\
[PartyEndpoint::GetEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentitytype.md)


## Related topics

- [PartyEndpoint::GetEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentitytype.md)
- [PartyNetwork::DestroyEndpoint](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_destroyendpoint.md)
- [PartyNetwork::CreateEndpoint](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_createendpoint.md)
- [PartyLocalUser::GetEntityId](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentityid.md)
- [PartyChatControl::GetEntityId](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentityid.md)