PartyManager::GetChatControls

ローカル デバイスとすべてのリモート デバイス上のすべてのチャット コントロールの結合リストを含む配列を取得します。

構文

PartyError GetChatControls(  
    uint32_t* chatControlCount,  
    PartyChatControlArray* chatControls  
)  

パラメーター

chatControlCount uint32_t*
出力

chatControls で提供されるチャット コントロールの出力数。

chatControls PartyChatControlArray*
ライブラリに割り当てられたサイズ *chatControlCount の出力配列

すべてのチャット コントロールの一覧を含む、ライブラリに割り当てられた出力配列。

戻り値

PartyError

呼び出しが成功した場合は c_partyErrorSuccess、それ以外の場合はエラー コードになります。 人間が判読できる形式のエラー コードは、GetErrorMessage() を介して取得できます。

備考

PartyManager::StartProcessingStateChanges() によって PartyChatControlDestroyedStateChange が提供されると、このメソッドが返す配列にチャット コントロールは存在しなくなります。

返された配列のメモリは、タイトルが PartyManager::StartProcessingStateChanges() を呼び出すか、PartyLocalDevice::CreateChatControl() が成功を返すたびに無効になります。

要件

ヘッダー: Party.h

関連項目

PartyManager
PartyLocalDevice::CreateChatControl
PartyLocalDevice::DestroyChatControl
PartyChatControlDestroyedStateChange