Get started for free
This topic has not yet been rated - Rate this topic

SessionEndingEventArgs Class

.NET Framework 4.5

Provides data for the SessionEnding event.

System.Object
  System.EventArgs
    Microsoft.Win32.SessionEndingEventArgs

Namespace:  Microsoft.Win32
Assembly:  System (in System.dll)
C#
C++
F#
VB
Copy 
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public class SessionEndingEventArgs : EventArgs

The SessionEndingEventArgs type exposes the following members.

  NameDescription
Public methodSessionEndingEventArgsInitializes a new instance of the SessionEndingEventArgs class using the specified value indicating the type of session close event that is occurring.
Top
  NameDescription
Public propertyCancelGets or sets a value indicating whether to cancel the user request to end the session.
Public propertyReasonGets the reason the session is ending.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A SessionEnding event is raised when the user is trying to log off or shut the system down.

This SessionEnding event can sometimes be canceled. Setting the Cancel property of a SessionEndingEventArgs to false will request that the session continue instead of ending. Making such a request provides no guarantee that the session will not end.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.