Skip to main content

chat_user::custom_user_context

Retrieves the app’s optional, private, custom pointer-sized context value previously associated with this user.

Syntax

Parameters

None.

Return value

Type: void* The pointer-sized value previously associated with this user; otherwise, a null pointer.

Remarks

This method retrieves the app’s private, custom pointer-sized context value previously associated with this chat_user object. If no custom user context has been set yet for this chat_user object, this method returns a null pointer. The custom user context is typically used as a “shortcut” that simplifies accessing local, app-specific memory associated with the user without requiring a mapping lookup. Use the chat_user::set_custom_user_context method to set the custom user context for a chat_user object.

Requirements

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

See also

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