Export (0) Print
Expand All

ServiceController Class

Represents a Windows service and allows you to connect to a running or stopped service, manipulate it, or get information about it.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.ServiceProcess.ServiceController

Namespace:  System.ServiceProcess
Assembly:  System.ServiceProcess (in System.ServiceProcess.dll)

[ServiceProcessDescriptionAttribute("ServiceControllerDesc")]
public class ServiceController : Component

The ServiceController type exposes the following members.

  NameDescription
Public methodServiceController()Initializes a new instance of the ServiceController class that is not associated with a specific service.
Public methodServiceController(String)Initializes a new instance of the ServiceController class that is associated with an existing service on the local computer.
Public methodServiceController(String, String)Initializes a new instance of the ServiceController class that is associated with an existing service on the specified computer.
Top

  NameDescription
Public propertyCanPauseAndContinueGets a value indicating whether the service can be paused and resumed.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyCanShutdownGets a value indicating whether the service should be notified when the system is shutting down.
Public propertyCanStopGets a value indicating whether the service can be stopped after it has started.
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyDependentServicesGets the set of services that depends on the service associated with this ServiceController instance.
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public propertyDisplayNameGets or sets a friendly name for the service.
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyMachineNameGets or sets the name of the computer on which this service resides.
Public propertyServiceHandleGets the handle for the service.
Public propertyServiceNameGets or sets the name that identifies the service that this instance references.
Public propertyServicesDependedOnThe set of services that this service depends on.
Public propertyServiceTypeGets the type of service that this object references.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyStatusGets the status of the service that is referenced by this instance.
Top

  NameDescription
Public methodCloseDisconnects this ServiceController instance from the service and frees all the resources that the instance allocated.
Public methodContinueContinues a service after it has been paused.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ServiceController and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteCommandExecutes a custom command on the service.
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodStatic memberGetDevices()Retrieves the device driver services on the local computer.
Public methodStatic memberGetDevices(String)Retrieves the device driver services on the specified computer.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodStatic memberGetServices()Retrieves all the services on the local computer, except for the device driver services.
Public methodStatic memberGetServices(String)Retrieves all the services on the specified computer, except for the device driver services.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodPauseSuspends a service's operation.
Public methodRefreshRefreshes property values by resetting the properties to their current values.
Public methodStart()Starts the service, passing no arguments.
Public methodStart(String[])Starts a service, passing the specified arguments.
Public methodStopStops this service and any services that are dependent on this service.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodWaitForStatus(ServiceControllerStatus)Infinitely waits for the service to reach the specified status.
Public methodWaitForStatus(ServiceControllerStatus, TimeSpan)Waits for the service to reach the specified status or for the specified time-out to expire.
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

You can use the ServiceController class to connect to and control the behavior of existing services. When you create an instance of the ServiceController class, you set its properties so it interacts with a specific Windows service. You can then use the class to start, stop, and otherwise manipulate the service.

You will most likely use the ServiceController component in an administrative capacity. For example, you could create a Windows or Web application that sends custom commands to a service through the ServiceController instance. This would be useful, because the Service Control Manager (SCM) Microsoft Management Console snap-in does not support custom commands.

After you create an instance of ServiceController, you must set two properties on it to identify the service with which it interacts: the computer name and the name of the service you want to control.

NoteNote

By default, MachineName is set to the local computer, so you do not need to change it unless you want to set the instance to point to another computer.

Generally, the service author writes code that customizes the action associated with a specific command. For example, a service can contain code to respond to an ServiceBase.OnPause command. In that case, the custom processing for the Pause task runs before the system pauses the service.

The set of commands a service can process depends on its properties; for example, you can set the CanStop property for a service to false. This setting renders the Stop command unavailable on that particular service; it prevents you from stopping the service from the SCM by disabling the necessary button. If you try to stop the service from your code, the system raises an error and displays the error message "Failed to stop servicename."

The following example demonstrates the use of the ServiceController class to control the SimpleService service example.

using System;
using System.ServiceProcess;
using System.Diagnostics;
using System.Threading;

namespace ServiceControllerSample
{
    class Program
    {
        public enum SimpleServiceCustomCommands
        { StopWorker = 128, RestartWorker, CheckWorker };
        static void Main(string[] args)
        {
            ServiceController[] scServices;
            scServices = ServiceController.GetServices();

            foreach (ServiceController scTemp in scServices)
            {

                if (scTemp.ServiceName == "Simple Service")
                {
                    // Display properties for the Simple Service sample 
                    // from the ServiceBase example.
                    ServiceController sc = new ServiceController("Simple Service");
                    Console.WriteLine("Status = " + sc.Status);
                    Console.WriteLine("Can Pause and Continue = " + sc.CanPauseAndContinue);
                    Console.WriteLine("Can ShutDown = " + sc.CanShutdown);
                    Console.WriteLine("Can Stop = " + sc.CanStop);
                    if (sc.Status == ServiceControllerStatus.Stopped)
                    {
                        sc.Start();
                        while (sc.Status == ServiceControllerStatus.Stopped)
                        {
                            Thread.Sleep(1000);
                            sc.Refresh();
                        }
                    }
                    // Issue custom commands to the service 
                    // enum SimpleServiceCustomCommands  
                    //    { StopWorker = 128, RestartWorker, CheckWorker };
                    sc.ExecuteCommand((int)SimpleServiceCustomCommands.StopWorker);
                    sc.ExecuteCommand((int)SimpleServiceCustomCommands.RestartWorker);
                    sc.Pause();
                    while (sc.Status != ServiceControllerStatus.Paused)
                    {
                        Thread.Sleep(1000);
                        sc.Refresh();
                    }
                    Console.WriteLine("Status = " + sc.Status);
                    sc.Continue();
                    while (sc.Status == ServiceControllerStatus.Paused)
                    {
                        Thread.Sleep(1000);
                        sc.Refresh();
                    }
                    Console.WriteLine("Status = " + sc.Status);
                    sc.Stop();
                    while (sc.Status != ServiceControllerStatus.Stopped)
                    {
                        Thread.Sleep(1000);
                        sc.Refresh();
                    }
                    Console.WriteLine("Status = " + sc.Status);
                    String[] argArray = new string[] { "ServiceController arg1", "ServiceController arg2" };
                    sc.Start(argArray);
                    while (sc.Status == ServiceControllerStatus.Stopped)
                    {
                        Thread.Sleep(1000);
                        sc.Refresh();
                    }
                    Console.WriteLine("Status = " + sc.Status);
                    // Display the event log entries for the custom commands 
                    // and the start arguments.
                    EventLog el = new EventLog("Application");
                    EventLogEntryCollection elec = el.Entries;
                    foreach (EventLogEntry ele in elec)
                    {
                        if (ele.Source.IndexOf("SimpleService.OnCustomCommand") >= 0 |
                            ele.Source.IndexOf("SimpleService.Arguments") >= 0)
                            Console.WriteLine(ele.Message);
                    }
                }
            }


        }
    }
}
// This sample displays the following output if the Simple Service 
// sample is running: 
//Status = Running 
//Can Pause and Continue = True 
//Can ShutDown = True 
//Can Stop = True 
//Status = Paused 
//Status = Running 
//Status = Stopped 
//Status = Running 
//4:14:49 PM - Custom command received: 128 
//4:14:49 PM - Custom command received: 129 
//ServiceController arg1 
//ServiceController arg2

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, 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.
Show:
© 2014 Microsoft