PartyXblManager::GetChatUsers - XBOX Game Development Documentation

Gets an array containing all chat users created by CreateLocalChatUser() and CreateRemoteChatUser().

Syntax

PartyError GetChatUsers(  
    uint32_t* userCount,  
    PartyXblChatUserArray* chatUsers  
)  

Parameters

userCount uint32_t*
output An output value indicating the number of chat users provided in chatUsers. chatUsers PartyXblChatUserArray*
library-allocated output array of size *endpointCount A library-allocated output array containing the local and remote chat users.

Return value

PartyError c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

The array is backed by the library’s internal memory. The array is only valid until the next call to either CreateLocalChatUser(), CreateRemoteChatUser(), StartProcessingStateChanges() or DestroyChatUser(). A call to DestroyChatUser() will also immediately invalidate the chat user object.

Requirements

Header: PartyXboxLive.h

See also

PartyXblManager
PartyXblManager::CreateLocalChatUser
PartyXblManager::CreateRemoteChatUser
PartyXblManager::DestroyChatUser

Last modified on August 20, 2026

Related topics

PartyXblManager::DestroyChatUser PartyXblManager::CreateRemoteChatUser PartyXblManager::CreateLocalChatUser PartyXblManager::GetEntityIdsFromXboxLiveUserIds PartyXblChatUser::GetLocal

⌘I