SessionChangeDescription.Reason Property

  • Reference

Definition

Namespace:
System.ServiceProcess
Assembly:
System.ServiceProcess.ServiceController.dll
Assembly:
System.ServiceProcess.dll
Package:
System.ServiceProcess.ServiceController v8.0.1
Package:
System.ServiceProcess.ServiceController v9.0.0-rc.2.24473.5
Source:
SessionChangeDescription.cs
Source:
SessionChangeDescription.cs
Source:
SessionChangeDescription.cs
Source:
SessionChangeDescription.cs
Source:
SessionChangeDescription.cs

Gets the reason for the session change.

public:
 property System::ServiceProcess::SessionChangeReason Reason { System::ServiceProcess::SessionChangeReason get(); };
public System.ServiceProcess.SessionChangeReason Reason { get; }
member this.Reason : System.ServiceProcess.SessionChangeReason
Public ReadOnly Property Reason As SessionChangeReason

Property Value

SessionChangeReason

One of the SessionChangeReason values.

Examples

The following code example shows the use of the Reason property in an implementation of the OnSessionChange method in a class derived from ServiceBase. This code example is part of a larger example provided for the ServiceBase class.

        // Handle a session change notice
        protected override void OnSessionChange(SessionChangeDescription changeDescription)
        {
#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.OnSessionChange", DateTime.Now.ToLongTimeString() +
                " - Session change notice received: " +
                changeDescription.Reason.ToString() + "  Session ID: " +
                changeDescription.SessionId.ToString());
#endif

    ' Handle a session change notice
    Protected Overrides Sub OnSessionChange(ByVal changeDescription As SessionChangeDescription)
#If LOGEVENTS Then
        System.Diagnostics.EventLog.WriteEntry("SimpleService.OnSessionChange", DateTime.Now.ToLongTimeString() + " - Session change notice received: " + changeDescription.Reason.ToString() + "  Session ID: " + changeDescription.SessionId.ToString())
#End If

Applies to