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

サインアウト遅延へのハンドルを取得します。この API は PC ではサポートされておらず、E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE を返します。

## 構文

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

### パラメーター

*deferral*   \_Out\_\
Type: XUserSignOutDeferralHandle\*

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

### 戻り値

Type: HRESULT

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

| 戻り値コード                                | 説明                   |
| ------------------------------------- | -------------------- |
| S\_OK                                 | 操作は成功しました。           |
| E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE | サインアウト遅延を提供できませんでした。 |

## 解説

<Note>この API は、microsoftgame.config の configVersion が "0" のゲームでは PC でサポートされておらず</Note>、E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE を返します。2022 年 6 月の GDK 以降、microsoftgame.config が以下のすべてを満たしている場合、この API は PC でサポートされます。

* configVersion が 1 と等しい
* タイトル ID が指定されている
* MSA App 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](/ja-jp/reference/system/xuser/functions/xuserclosesignoutdeferralhandle.md)
- [XSystemHandleType](/ja-jp/reference/system/xsystem/enums/xsystemhandletype.md)
- [XUser](/ja-jp/reference/system/xuser/xuser_members.md)
- [GDK 向け Unity C# API ラッパー](/ja-jp/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XUserCompare](/ja-jp/reference/system/xuser/functions/xusercompare.md)