Skip to main content

XUserUnregisterForChangeEvent

以前に登録したユーザー変更コールバックを解除します。

構文

パラメーター

token   _In_
Type: XTaskQueueRegistrationToken
XUserRegisterForChangeEvent が返した、登録解除対象のコールバックを識別するトークンです。 wait   _In_
Type: bool
保留中のコールバックが完了するまでブロックするかどうかを示します。

戻り値

Type: bool wait が false で登録解除が保留中の場合は false を返します。それ以外の場合は true を返します。

解説

この関数は、時間依存スレッドから呼び出しても安全ではありません。詳細については、時間依存スレッド を参照してください。
通知の登録解除: 登録解除により、そのトークンに対するコールバックが登録済みコールバックのセットから削除されます。
  • コールバック トークンに対してコールバックが実行されていない場合、呼び出しは true を返します。
  • コールバックが実行中で wait が true の場合、実行中のコールバックが完了するまで呼び出しはブロックします。
  • コールバックが実行中で wait が false の場合、呼び出しはブロックせず false を返します。トークンに対するコールバックが完了すると、トークンは自動的に登録解除されます。
このメカニズムにより、以下のコーディング パターンが可能になります。
  1. 登録解除呼び出しでブロックすることで、登録解除後にコールバックが呼び出されないことを保証できます。
  2. ブロックしないことも選択できます。データを削除する前にコールバックが完了することを保証する必要がある場合は、wait を false にして定期的に unregister を呼び出せます。最終的に true が返された時点で、すべてのコールバックが完了しており、状態を削除できます。
  3. unregister 呼び出しがコールバックを呼び出さない場合、wait に false を渡して戻り値を無視することもできます。
ユーザー変更コールバックを登録するには、XUserRegisterForChangeEvent を呼び出します。 XUserChangeEvent 列挙体は、変更イベントの種類を指定します。 XUserChangeEventCallback は、ユーザー変更イベントのコールバックです。 以下の例は、ユーザー変更イベントを処理する方法を示しています。

要件

ヘッダー: XUser.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、Steam Deck、XBOX One ファミリ本体および XBOX Series 本体

概念ドキュメント

関連項目

XUser XUserRegisterForChangeEvent XUserChangeEvent XUserChangeEventCallback
最終更新日 2026年8月24日