chat_manager::get_chat_users
Retrieves the collection of local and remote users that have been added to the chat instance.Syntax
Parameters
chatUserCount _Out_Type: uint32_t* The total number of local and remote users that have been added to the chat instance. chatUsers _Outptr_result_buffer_(*chatUserCount)
Type: chat_user_array* An array of chat_user pointers that represents the local and remote users that have been added to the chat instance.
Return value
Type: void None.Remarks
This method retrieves the collection of local and remote users that have been added to the chat instance, returning the total number of users inchatUserCount and an array of chat_user pointers, each of which represents a local or remote user, in chatUsers. The array pointer returned in chatUsers is valid until the next call to any of the following methods:
- chat_manager::add_local_user
- chat_manager::add_remote_user
- chat_manager::cleanup
- chat_manager::remove_user
chat_user objects remain valid until the user has been removed by a call to chat_manager::remove_user. For more information about initializing and cleaning up a chat instance, see Using the Game Chat 2 C++ API.
Requirements
Header: GameChat2.h Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesSee also
Intro to Game Chat 2chat_user
chat_manager