> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XUserUnregisterForChangeEvent

> XUserUnregisterForChangeEvent

# XUserUnregisterForChangeEvent

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

## 構文

```cpp theme={null}
bool XUserUnregisterForChangeEvent(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)  
```

### パラメーター

*token*   \_In\_\
Type: [XTaskQueueRegistrationToken](/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken)

[XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent) が返した、登録解除対象のコールバックを識別するトークンです。

*wait*   \_In\_\
Type: bool

保留中のコールバックが完了するまでブロックするかどうかを示します。

### 戻り値

Type: bool

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

## 解説

<Note>この関数は、時間依存スレッドから呼び出しても安全ではありません。詳細については、[時間依存スレッド](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads) を参照してください。</Note>

通知の登録解除:

登録解除により、そのトークンに対するコールバックが登録済みコールバックのセットから削除されます。

* コールバック トークンに対してコールバックが実行されていない場合、呼び出しは true を返します。
* コールバックが実行中で wait が true の場合、実行中のコールバックが完了するまで呼び出しはブロックします。
* コールバックが実行中で wait が false の場合、呼び出しはブロックせず false を返します。トークンに対するコールバックが完了すると、トークンは自動的に登録解除されます。

このメカニズムにより、以下のコーディング パターンが可能になります。

1. 登録解除呼び出しでブロックすることで、登録解除後にコールバックが呼び出されないことを保証できます。
2. ブロックしないことも選択できます。データを削除する前にコールバックが完了することを保証する必要がある場合は、wait を false にして定期的に unregister を呼び出せます。最終的に true が返された時点で、すべてのコールバックが完了しており、状態を削除できます。
3. unregister 呼び出しがコールバックを呼び出さない場合、wait に false を渡して戻り値を無視することもできます。

ユーザー変更コールバックを登録するには、[XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent) を呼び出します。
[XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent) 列挙体は、変更イベントの種類を指定します。
[XUserChangeEventCallback](/reference/system/xuser/functions/xuserchangeeventcallback) は、ユーザー変更イベントのコールバックです。

以下の例は、ユーザー変更イベントを処理する方法を示しています。

```cpp theme={null}
HRESULT RegisterForChanges()
{
    RETURN_HR_IF(E_UNEXPECTED, _token.token != 0);
    RETURN_IF_FAILED(XUserRegisterForChangeEvent(
        _queue,
        this,
        UserChangeEventHandler,
        &_token));
    return S_OK;
}

void UnregisterForChanges()
{
    XUserUnregisterForChangeEvent(_token, false);
    _token.token = 0;
}

void UserChangeEventHandler(
    XUserLocalId userLocalId,
    XUserChangeEvent event)
{
    auto iter = std::find_if(
        _users.begin(),
        _users.end(),
        [&userLocalId](const User& candidate)
    {
        XUserLocalId candidateUserLocalId;
        XUserGetLocalId(candidate.Handle(), &candidateUserLocalId);
        return candidateUserLocalId == userLocalId;
    });

    // User not known
    if (iter == _users.end())
    {
        return;
    }

    auto handle = iter->Handle();

    // If a guest gets signed out, immediately close the handle
    bool isGuest;
    if (SUCCEEDED_LOG(XUserGetIsGuest(handle, &isGuest)) &&
        isGuest &&
        event == XUserChangeEvent::SignedOut)
    {
        _users.erase(iter);
    }

    if (event == XUserChangeEvent::SigningOut)
    {
        // Delay the user signing out just for fun
        XUserSignOutDeferralHandle deferral;
        if (SUCCEEDED_LOG(XUserGetSignOutDeferral(&deferral)))
        {
            // Hold the deferral for 5 seconds then close it
            std::thread completeDeferralThread(
                [deferral]()
            {
                std::this_thread::sleep_for(std::chrono::milliseconds(5000));
                XUserCloseSignOutDeferralHandle(deferral);
            });

            completeDeferralThread.detach();
        }
    }

    if (event == XUserChangeEvent::GamerPicture)
    {
        iter->LoadGamerPicAsync(_queue);
    }
}
```

## 要件

**ヘッダー:** XUser.h

**ライブラリ:** xgameruntime.lib

**サポートされているプラットフォーム:** Windows、Steam Deck、XBOX One ファミリ本体および XBOX Series 本体

## 概念ドキュメント

* [時間依存スレッド](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 関連項目

[XUser](/reference/system/xuser/xuser_members)

[XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent)

[XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent)

[XUserChangeEventCallback](/reference/system/xuser/functions/xuserchangeeventcallback)


## Related topics

- [XUserRegisterForChangeEvent](/ja-jp/reference/system/xuser/functions/xuserregisterforchangeevent.md)
- [XUserGetIsGuest](/ja-jp/reference/system/xuser/functions/xusergetisguest.md)
- [XTaskQueueRegistrationToken](/ja-jp/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken.md)
- [GDK 向け Unity C# API ラッパー](/ja-jp/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XUser](/ja-jp/reference/system/xuser/xuser_members.md)