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

# chat_manager::get_chat_users

> chat_manager::get_chat_users

# chat\_manager::get\_chat\_users

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

<a id="syntaxSection" />

## 语法

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

<a id="syntaxSection" />

### 参数

*chatUserCount*   \_Out\_<br />类型：uint32\_t\*

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

*chatUsers*   \_Outptr\_result\_buffer\_(\*chatUserCount)<br />类型：[chat\_user\_array](/reference/chat/gamechat2/classes/chat_user/chat_user)\*

表示已添加到聊天实例的本地和远程用户的 [chat\_user](/reference/chat/gamechat2/classes/chat_user/chat_user) 指针数组。

<a id="retvalSection" />

### 返回值

类型：void

无。

<a id="remarksSection" />

## 备注

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

* [chat\_manager::add\_local\_user](/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_local_user)
* [chat\_manager::add\_remote\_user](/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_remote_user)
* [chat\_manager::cleanup](/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_cleanup)
* [chat\_manager::remove\_user](/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_remove_user)

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

<a id="requirementsSection" />

## 要求

**头文件：** GameChat2.h

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

<a id="seealsoSection" />

## 另请参阅

[Game Chat 2 简介](/services/xbox-services/multiplayer/chat/game-chat2/game-chat-2-intro)<br />[chat\_user](/reference/chat/gamechat2/classes/chat_user/chat_user)<br />[chat\_manager](/reference/chat/gamechat2/classes/chat_manager/chat_manager)


## Related topics

- [PartyXblManager::GetChatUsers](/zh-CN/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getchatusers.md)
- [chat_manager::remove_user](/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_remove_user.md)
- [chat_manager::add_remote_user](/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_remote_user.md)
- [chat_manager::add_local_user](/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_local_user.md)
- [chat_manager::initialize](/zh-CN/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_initialize.md)
