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

# get_chat_users

> chat_manager::get_chat_users

# chat\_manager::get\_chat\_users

检索已添加到聊天实例的本地和远程用户的集合。

## 语法

```cpp theme={null}
void get_chat_users(  
    uint32_t* chatUserCount,  
    chat_user_array* chatUsers  
)  
```

### 参数

*chatUserCount*   \_Out\_\
类型：uint32\_t\*

已添加到聊天实例的本地和远程用户的总数。

*chatUsers*   \_Outptr\_result\_buffer\_(\*chatUserCount)\
类型：[chat\_user\_array](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_user/chat_user.md)\*

表示已添加到聊天实例的本地和远程用户的 [chat\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_user/chat_user.md) 指针数组。

### 返回值

类型：void

无。

## 备注

此方法检索已添加到聊天实例的本地和远程用户的集合，在 `chatUserCount` 中返回用户总数，在 `chatUsers` 中返回 [chat\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_user/chat_user.md) 指针的数组，每个指针代表一个本地或远程用户。返回到 `chatUsers` 中的数组指针在下次调用以下任一方法之前均有效：

* [chat\_manager::add\_local\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_local_user.md)
* [chat\_manager::add\_remote\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_remote_user.md)
* [chat\_manager::cleanup](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_cleanup.md)
* [chat\_manager::remove\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_remove_user.md)

在通过调用 `chat_manager::remove_user` 移除用户之前，各个 `chat_user` 对象将保持有效。有关初始化和清理聊天实例的详细信息，请参阅[使用 Game Chat 2 C++ API](https://docs.xbox.com/zh-CN/services/xbox-services/multiplayer/chat/game-chat2/using-game-chat-2.md)。

## 要求

**头文件：** GameChat2.h

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## 另请参阅

[Game Chat 2 简介](https://docs.xbox.com/zh-CN/services/xbox-services/multiplayer/chat/game-chat2/game-chat-2-intro.md)\
[chat\_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_user/chat_user.md)\
[chat\_manager](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_manager/chat_manager.md)


## Related topics

- [chat_user](https://docs.xbox.com/zh-CN/reference/chat/gamechat2/classes/chat_user/chat_user.md)
- [PartyXblManager::GetChatUsers](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getchatusers.md)
- [PartyXblManager](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/partyxblmanager.md)
- [PartyXblChatUser::GetXboxUserId](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_getxboxuserid.md)
- [PartyXblChatUser::GetLocal](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_getlocal.md)