XUserUnregisterForChangeEvent

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

構文

bool XUserUnregisterForChangeEvent(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)  

パラメーター

token _In_
型: XTaskQueueRegistrationToken

XUserRegisterForChangeEvent の返すトークン。登録解除するコールバックを示します。

wait _In_
型: bool

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

戻り値

型: bool

wait が false で登録解除が保留になっている場合は、false が返されます。 それ以外の場合は、true が返されます。

解説

通知の登録解除:

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

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

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

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

ユーザー変更コールバックを登録するには、XUserRegisterForChangeEvent を呼び出します。 Xuserchangeevent 列挙型は、変更イベントの種類を指定します。 XUserChangeEventCallback は、ユーザー変更イベントのコールバックです。

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

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 本体

関連項目

XUser

XUserRegisterForChangeEvent

XUserChangeEvent

XUserChangeEventCallback