XGameStreamingUnregisterConnectionStateChanged

  • [アーティクル]

以前に登録した XGameStreamingConnectionStateChangedCallback を登録解除します。

構文

bool XGameStreamingUnregisterConnectionStateChanged(
         XTaskQueueRegistrationToken token,
         bool wait
)

パラメーター

token _In_ 型: XTaskQueueRegistrationToken

XGameStreamingRegisterConnectionStateChanged によって登録されたコールバックに対応するトークン。

wait   
型: bool

wait が true に設定されている場合、XGameStreamingUnregisterConnectionStateChanged は、登録が取り消され、未処理のコールバックが完了するまで返されません。

wait が false に設定されている場合、XGameStreamingUnregisterConnectionStateChanged は登録が取り消されるとすぐに戻ります。 新しいコールバックは配信されませんが、進行中のコールバックは、関数が戻ったときに実行されている可能性があります。

戻り値

型: bool

登録解除が成功した場合は true、成功しなかった場合は false を返します。

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。

この API を使うと、ストリーミング クライアント デバイスの接続変更をリッスンするのを停止できます。

いずれかのクライアントがストリーミングしているかどうかを XGameStreamingIsStreaming で大まかに確認するだけにした場合や、ストリーミング クライアントのためのエクスペリエンスの最適化が不要になった場合は、この登録解除を行う必要があります。

要件

ヘッダー: xgamestreaming.h

ライブラリ: xgameruntime.lib

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

関連項目

XGameStreamingConnectionStateChangedCallback
XGameStreamingRegisterConnectionStateChanged
XGameStreaming