> ## 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>如果遊戲的 configVersion 為 "0"，PC 上不支援此 API</Note>
（於其 microsoftgame.config 中），且會傳回 E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE。從
2022 年 6 月 GDK 開始，如果 microsoftgame.config 具有下列所有項目，PC 上便支援此 API：

* configVersion 等於 1
* 指定遊戲識別碼
* 指定 MSA 應用程式識別碼

若要取得登出延遲，請在 [XUserChangeEvent](/zh-TW/reference/system/xuser/enums/xuserchangeevent) 為 [XUserChangeEvent::SigningOut](/zh-TW/reference/system/xuser/enums/xuserchangeevent) 時呼叫 [XUserChangeEventCallback](/zh-TW/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](/zh-TW/reference/system/xuser/xuser_members)

[XUserChangeEventCallback](/zh-TW/reference/system/xuser/functions/xuserchangeeventcallback)

[XUserChangeEvent](/zh-TW/reference/system/xuser/enums/xuserchangeevent)


## Related topics

- [XUserGetSignOutDeferral](/ja-jp/reference/system/xuser/functions/xusergetsignoutdeferral.md)
- [XUserCloseSignOutDeferralHandle](/reference/system/xuser/functions/xuserclosesignoutdeferralhandle.md)