このストリームのレンダリング デバイスに関連付けられているユーザーを取得します。
構文
void get_users(
uint32_t* chatUserCount,
chat_user_array* chatUsers
)
パラメーター
chatUserCount _Out_
型: uint32_t*
このストリームのレンダリング デバイスに関連付けられているユーザーの合計数。
chatUsers _Outptr_result_buffer_(*chatUserCount)
型: chat_user_array*
このストリームのレンダリング デバイスに関連付けられているユーザーを表す chat_user ポインターの配列。
戻り値
型: void
ありません。
解説
このメソッドは、このストリームのレンダリング デバイスに関連付けられているユーザーのコレクションを取得し、chatUserCount のユーザーの合計数と chatUsers の chat_user ポインターの配列を返します。
chatUsers に入れて返された配列ポインターは、このストリームが破棄されるまで有効です。
個々の chat_user オブジェクトは、chat_manager::remove_user への呼び出しによってユーザーが削除されるまで有効です。
chat_manager::remove_user を呼び出した結果としてこのストリームが破棄された場合は、その削除されたユーザーの chat_user ポインターも無効になります。
チャット インスタンスの初期化とクリーンアップの詳細については、「ゲーム チャット 2 C++ API の使用」を参照してください。
要件
ヘッダー: GameChat2.h
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体