Skip to main content

chat_user::local

Returns a const pointer to the chat_user_local object associated with this user, if the user is local.

Syntax

Parameters

None.

Return value

Type: const chat_user_local* Returns a const pointer to the chat_user_local object associated to this user, if the user is local; otherwise, NULL.

Remarks

This method returns a const pointer to the chat_user_local object associated with this chat_user object, if the user is local. The returned const pointer remains valid for the life of the associated chat_user object, which is until the user has been removed by a call to the chat_manager::remove_user method. For more information about adding local and remote users to the local chat_manager instance for your app, see the Adding users to Game Chat 2 section in Using the Game Chat 2 C++ API.

Requirements

Header: GameChat2.h Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

See also

Intro to Game Chat 2
chat_user::local
chat_user
Last modified on August 20, 2026