Application.SessionEnding Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Occurs when the user ends the Windows session by logging off or shutting down the operating system.
public:
event System::Windows::SessionEndingCancelEventHandler ^ SessionEnding;public event System.Windows.SessionEndingCancelEventHandler SessionEnding;member this.SessionEnding : System.Windows.SessionEndingCancelEventHandler Public Custom Event SessionEnding As SessionEndingCancelEventHandler Event Type
Examples
The following example demonstrates how to handle the SessionEnding event and allow the user to cancel it.
<Application
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
x:Class="SDKSample.App"
StartupUri="MainWindow.xaml"
SessionEnding="App_SessionEnding" />
using System.Windows;
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;
}
}
}
}
Imports System.Windows
Namespace SDKSample
Partial Public Class App
Inherits Application
Private Sub App_SessionEnding(ByVal sender As Object, ByVal e As SessionEndingCancelEventArgs)
' Ask the user if they want to allow the session to end
Dim msg As String = String.Format("{0}. End session?", e.ReasonSessionEnding)
Dim result As MessageBoxResult = MessageBox.Show(msg, "Session Ending", MessageBoxButton.YesNo)
' End session, if specified
If result = MessageBoxResult.No Then
e.Cancel = True
End If
End Sub
End Class
End Namespace
Remarks
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 (ReasonSessionEnding.Logoff and ReasonSessionEnding.Shutdown).
SessionEnding is not raised by console applications.
SessionEnding is raised only on the thread that creates the Application object.
SessionEnding is not raised for XAML browser applications (XBAPs).
