XUserGetSignOutDeferral

サインアウト遅延ハンドルへのハンドルを取得します。 この API は PC ではサポートされていないため、E_GAMEUSER_DEFERRAL_NOT_AVAILABLE を返します。

構文

HRESULT XUserGetSignOutDeferral(  
         XUserSignOutDeferralHandle* deferral  
)  

パラメーター

deferral _Out_
型: XUserSignOutDeferralHandle*

サインアウト遅延ハンドルへのハンドルが格納されます。

戻り値

型: HRESULT

HRESULT 成功またはエラー コード。

リターン コード	説明
S_OK	操作に成功しました。
E_GAMEUSER_DEFERRAL_NOT_AVAILABLE	サインアウト遅延を提供できませんでした。

解説

注意

この API は、ゲームの microsoftgame.config に "0" の configVersion があり、E_GAMEUSER_DEFERRAL_NOT_AVAILABLE を返す場合、PC ではサポートされません。 June 2022 GDK 以降、microsoftgame.config に次のすべてが含まれている場合、この API は PC でサポートされます。

• configVersion が 1 に等しい
• タイトル ID を指定します
• MSA アプリ ID を指定します

サインアウト遅延を取得するには、XUserChangeEvent が XUserChangeEvent::SigningOut であるときに XUserChangeEventCallback を呼び出します。 SigningOut イベントの間に遅延を取得できないことがあります。 いったん遅延を取得すると、遅延が完了するかタイムアウトが経過するまでユーザーはサインインしたままになります。

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

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

XUserChangeEventCallback

XUserChangeEvent