XUserGetSignOutDeferral

项目
05/10/2023

检索注销延迟的句柄。此 API 在电脑上不受支持，将返回 E_GAMEUSER_DEFERRAL_NOT_AVAILABLE。

语法

HRESULT XUserGetSignOutDeferral(  
         XUserSignOutDeferralHandle* deferral  
)

参数

deferral _Out_
类型：XUserSignOutDeferralHandle*

包含注销延迟的句柄。

返回值

类型：HRESULT

HRESULT 成功或错误代码。

返回代码	说明
S_OK	操作成功。
E_GAMEUSER_DEFERRAL_NOT_AVAILABLE	无法提供注销延迟。

备注

注意

如果游戏的 microsoftgame.config 配置版本为“0”，并且将返回 E_GAMEUSER_DEFERRAL_NOT_AVAILABLE，则电脑不支持此 API。从 2022 年 6 月 GDK 开始，如果 microsoftgame.config 具有以下所有内容，则电脑上支持此 API：

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);
    }
}