This documentation is archived and is not being maintained.

Application.SessionEnding Event

Occurs when the user ends the Windows session by logging off or shutting down the operating system.

Namespace: System.Windows
Assembly: PresentationFramework (in presentationframework.dll)
XML Namespace:

public event SessionEndingCancelEventHandler SessionEnding
/** @event */
public void add_SessionEnding (SessionEndingCancelEventHandler value)

/** @event */
public void remove_SessionEnding (SessionEndingCancelEventHandler value)

In JScript, you can handle the events defined by a class, but you cannot define your own.
<object SessionEnding="SessionEndingCancelEventHandler" .../>

By default, an application shuts down when the Windows session ends, which occurs when a user logs off or shuts down. When this happens, Windows asks each open application to shut down. However, it is possible that an application may not be ready to shut down when this occurs. For example, an application may have data that is in an inconsistent state, or in the middle of a long-running operation. In these situations, it may be desirable to prevent the session from ending, and may be more desirable to allow users the option to decide whether or not to let the session to end.

You can detect when a session ends by handling the SessionEnding event. If an application needs to prevent the session from ending, the SessionEndingCancelEventArgs argument that is passed to the event handler exposes the Cancel that you set to true (the default value is false).

If SessionEnding is unhandled, or is handled without being cancelled, Shutdown is called and the Exit event is raised.

To obtain more information about why the session is ending, an application can inspect ReasonSessionEnding, which is one of the ReasonSessionEnding values (Logoff and Shutdown).

SessionEnding is not raised by console applications.

SessionEnding is raised only on the thread that creates the Application object.

The following example demonstrates how to handle the SessionEnding event and allow the user to cancel it.

    SessionEnding="App_SessionEnding" />

using System.Windows; // Application, SessionEndingCancelEventArgs, MessageBox, MessageBoxResult, MessageBoxButton

namespace SDKSample
    public partial class App : Application
        void App_SessionEnding(object sender, SessionEndingCancelEventArgs e)
            // Ask the user if they want to allow the session to end
            string msg = string.Format("{0}. End session?", e.ReasonSessionEnding);
            MessageBoxResult result = MessageBox.Show(msg, "Session Ending", MessageBoxButton.YesNo);

            // End session, if specified
            if (result == MessageBoxResult.No)
                e.Cancel = true;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0