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

# PartyEndpoint::GetEntityId

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

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

## Syntax

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

### Parameters

**`entityId`**   [PartyString\*](/services/playfab/multiplayer/networking/reference/typedefs)\
*library-allocated output, may return nullptr*

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

### Return value

PartyError

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

## Remarks

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

## Requirements

**Header:** Party.h

## See also

[PartyEndpoint](/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/partyendpoint)\
[PartyEndpoint::GetEntityType](/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentitytype)


## Related topics

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