chat_manager::remove_user

Artikel
06/22/2023

Removes a user, either local or remote, from the local chat_manager instance.

Syntax

void remove_user(  
    chat_user* chatUser  
)

Parameters

chatUser _Post_invalid_
Type: chat_user*

The chat_user to remove.

Return value

Type: void

Remarks

This method allows game chat to reclaim resources associated with this user.

chat_manager::remove_user() must not be called while processing state changes (i.e. after chat_manager::start_processing_state_changes() has been called and before the corresponding call to chat_manager::finish_processing_state_changes()). Calling chat_manager::remove_user() while state changes are being processed can invalidate the memory associated with the removed user, even if a pointer to the memory associated with that user was returned in a state change. If audio manipulation is enabled, the memory associated with a removed user will remain valid until the audio manipulation streams associated with the user have been destroyed.

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles