XUserRegisterForChangeEvent

  • [アーティクル]

ユーザー変更イベントのコールバックを登録します。

構文

HRESULT XUserRegisterForChangeEvent(  
         XTaskQueueHandle queue,  
         void* context,  
         XUserChangeEventCallback* callback,  
         XTaskQueueRegistrationToken* token  
)

パラメーター

queue _In_opt_
型: XTaskQueueHandle

操作の実行対象の非同期キューのハンドル。

context _In_opt_
型: void*

コールバックに渡されるユーザー定義コンテキスト。

callback _In_
Type: XUserChangeEventCallback*

登録するためのユーザー定義コールバック。

token _Out_
型: XTaskQueueRegistrationToken*

登録されているコールバックを識別するトークンが格納されます。 このトークンを使用して、コールバックを登録解除します。

戻り値

型: HRESULT

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

解説

注意

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

XUserChangeEvent 列挙型は、変更イベントの種類を指定します。 XUserChangeEventCallback は、ユーザー変更イベントのコールバックです。

以前登録したユーザー変更コールバックを登録解除するには、XUserUnregisterForChangeEvent を呼び出します。

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

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、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XUser

XUserChangeEvent

XUserChangeEventCallback

XUserUnregisterForChangeEvent