> ## 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.

# XUserGetSignOutDeferral

> XUserGetSignOutDeferral

# XUserGetSignOutDeferral

检索注销延迟的句柄。PC 上不支持此 API，将会返回
E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE。

## 语法

```cpp theme={null}
HRESULT XUserGetSignOutDeferral(  
         XUserSignOutDeferralHandle* deferral  
)  
```

### 参数

*deferral*   \_Out\_\
类型：XUserSignOutDeferralHandle\*

包含注销延迟的句柄。

### 返回值

类型：HRESULT

HRESULT 成功或错误代码。

| 返回代码                                  | 说明        |
| ------------------------------------- | --------- |
| S\_OK                                 | 操作成功。     |
| E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE | 无法提供注销延迟。 |

## 注解

<Note>如果游戏在其 microsoftgame.config 中的 configVersion 为"0"，则 PC 上不支持此 API</Note>
将会返回 E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE。自
2022 年 6 月 GDK 起，如果 microsoftgame.config 满足以下所有条件，则 PC 上支持此 API：

* configVersion 等于 1
* 指定了标题 ID
* 指定了 MSA 应用 ID

若要获取注销延迟，请在 [XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent) 为 [XUserChangeEvent::SigningOut](/reference/system/xuser/enums/xuserchangeevent) 时调用 [XUserChangeEventCallback](/reference/system/xuser/functions/xuserchangeeventcallback)。在 **SigningOut** 事件期间可能无法获取延迟。一旦获得延迟，用户将保持登录状态，直到所有延迟完成或超时时间过去。

以下示例演示如何处理用户更改事件。

```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 主机

## 另请参阅

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

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

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


## Related topics

- [XUserCloseSignOutDeferralHandle](/zh-CN/reference/system/xuser/functions/xuserclosesignoutdeferralhandle.md)
- [XSystemHandleType](/zh-CN/reference/system/xsystem/enums/xsystemhandletype.md)
- [XUser](/zh-CN/reference/system/xuser/xuser_members.md)
- [面向 GDK 的 Unity C# API 包装器](/zh-CN/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XUserCompare](/zh-CN/reference/system/xuser/functions/xusercompare.md)