Skip to main content

XUserGetSignOutDeferral

Retrieves a handle to the sign out deferral. This API is not supported on PC and will return E_GAMEUSER_DEFERRAL_NOT_AVAILABLE.

Syntax

Parameters

deferral   _Out_
Type: XUserSignOutDeferralHandle*
Contains a handle to the sign out deferral.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

This API is not supported on PC if the game has a configVersion of “0”
in their microsoftgame.config and will return E_GAMEUSER_DEFERRAL_NOT_AVAILABLE. Starting with the June 2022 GDK, this API is supported on PC if the microsoftgame.config has all of the following:
  • configVersion equal to 1
  • Specifies a title ID
  • Specifies an MSA App ID
To obtain a sign out deferral, call XUserChangeEventCallback when the XUserChangeEvent is XUserChangeEvent::SigningOut. Deferrals may not be available during a SigningOut event. Once you obtain a deferral, the user remains signed in until all deferrals complete or a timeout elapses. The following example demonstrates how to handle user change events.

Requirements

Header: XUser.h Library: xgameruntime.lib Supported platforms: Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

See also

XUser XUserChangeEventCallback XUserChangeEvent
Last modified on August 20, 2026