XGameStreamingGetClients

現在接続されている各クライアントの ID を取得します。

構文

HRESULT XGameStreamingGetClients(  
         uint32_t clientCount,  
         XGameStreamingClientId* clients,  
         uint32_t* clientsUsed  
)

clientCount _In_
型: uint32_t

クライアントの配列に格納できるクライアントの最大数。

クライアント _Out_writes_to_(clientCount,clientsUsed)
型: XGameStreamingClientId

接続されているクライアントの ID を格納するバッファー。

clientsUsed _Out_
型: uint32_t*

クライアントの配列に実際に書き込まれたクライアントの数。

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合はエラーコードを返します。

エラーコード	エラー値	エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	XGameStreaming ランタイムが初期化されていません。他の API を呼び出す前に XGameStreamingInitialize を呼び出してください。
E_NOT_SUFFICIENT_BUFFER	0x7A	clientCount に指定された数が、現在接続されているクライアントの数よりも小さいです。

エラーコードの一覧については、「エラーコード」を参照してください。

現在接続されているすべてのストリーミングクライアントデバイスの XGameStreamingClientId を取得するために使用されます。

いずれかのデバイスが接続してストリーミングしているかどうかを特定しようとしているだけの場合は、XGameStreamingIsStreaming の使用を検討してください。

ストリーミングクライアントの接続時や切断時にゲームで通知を受け取る必要がある場合は、XGameStreamingRegisterConnectionStateChanged の使用を検討してください。

ヘッダー: xgamestreaming.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体