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

Recupera un identificador al aplazamiento de cierre de sesión. Esta API no es compatible en PC y devolverá
E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE.

## Sintaxis

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

### Parámetros

*deferral*   \_Out\_\
Tipo: XUserSignOutDeferralHandle\*

Contiene un identificador al aplazamiento de cierre de sesión.

### Valor devuelto

Tipo: HRESULT

Código de éxito o de error HRESULT.

| Código de retorno                     | Descripción                                                  |
| ------------------------------------- | ------------------------------------------------------------ |
| S\_OK                                 | La operación se realizó correctamente.                       |
| E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE | No se pudo proporcionar un aplazamiento de cierre de sesión. |

## Comentarios

<Note>Esta API no es compatible en PC si el juego tiene un configVersion de "0"</Note>
en su microsoftgame.config y devolverá E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE. A partir del
GDK de junio de 2022, esta API es compatible en PC si el archivo microsoftgame.config cumple todo lo siguiente:

* configVersion igual a 1
* Especifica un identificador de título
* Especifica un identificador de aplicación de MSA

Para obtener un aplazamiento de cierre de sesión, llame a [XUserChangeEventCallback](/reference/system/xuser/functions/xuserchangeeventcallback) cuando el [XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent) sea [XUserChangeEvent::SigningOut](/reference/system/xuser/enums/xuserchangeevent). Es posible que los aplazamientos no estén disponibles durante un evento **SigningOut**. Una vez que obtenga un aplazamiento, el usuario permanece con la sesión iniciada hasta que se completen todos los aplazamientos o transcurra un tiempo de espera.

El ejemplo siguiente muestra cómo controlar los eventos de cambio de usuario.

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

## Requisitos

**Encabezado:** XUser.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatibles:** Windows, Steam Deck, consolas de la familia XBOX One y consolas XBOX Series

## Consulte también

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

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

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


## Related topics

- [XUserCloseSignOutDeferralHandle](/es/reference/system/xuser/functions/xuserclosesignoutdeferralhandle.md)
- [XSystemHandleType](/es/reference/system/xsystem/enums/xsystemhandletype.md)
- [XUser](/es/reference/system/xuser/xuser_members.md)
- [Contenedores de API de C# de Unity para el GDK](/es/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XUserCompare](/es/reference/system/xuser/functions/xusercompare.md)