Edit

Share via

PartyManager::GetChatControls

  • Article

Gets an array that contains a combined list of all chat controls on the local device and all remote devices.

Syntax

PartyError GetChatControls(  
    uint32_t* chatControlCount,  
    PartyChatControlArray* chatControls  
)

Parameters

chatControlCount   uint32_t*
output

The output number of chat controls provided in chatControls.

chatControls   PartyChatControlArray*
library-allocated output array of size *chatControlCount

A library-allocated output array containing the list of all chat controls.

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

Once a PartyChatControlDestroyedStateChange has been provided by PartyManager::StartProcessingStateChanges(), the chat control will no longer be present in the array returned by this method.

The memory for the returned array is invalidated whenever the title calls PartyManager::StartProcessingStateChanges() or PartyLocalDevice::CreateChatControl() returns success.

Requirements

Header: Party.h

See also

PartyManager
PartyLocalDevice::CreateChatControl
PartyLocalDevice::DestroyChatControl
PartyChatControlDestroyedStateChange