SessionEndingEventArgs Class

 

Provides data for the SessionEnding event.

Namespace:   Microsoft.Win32
Assembly:  System (in System.dll)

System.Object
  System.EventArgs
    Microsoft.Win32.SessionEndingEventArgs

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class SessionEndingEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodSessionEndingEventArgs(SessionEndReasons)

Initializes a new instance of the SessionEndingEventArgs class using the specified value indicating the type of session close event that is occurring.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether to cancel the user request to end the session.

System_CAPS_pubpropertyReason

Gets the reason the session is ending.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: