ServiceController Класс

Определение

Представляет службу Windows и позволяет подключаться к запущенной или остановленной службе, управлять работой службы и получать сведения о ней.Represents a Windows service and allows you to connect to a running or stopped service, manipulate it, or get information about it.

public ref class ServiceController : System::ComponentModel::Component
public ref class ServiceController : IDisposable
public class ServiceController : System.ComponentModel.Component
public class ServiceController : IDisposable
[System.ServiceProcess.ServiceProcessDescription("ServiceControllerDesc")]
public class ServiceController : System.ComponentModel.Component
type ServiceController = class
    inherit Component
type ServiceController = class
    interface IDisposable
[<System.ServiceProcess.ServiceProcessDescription("ServiceControllerDesc")>]
type ServiceController = class
    inherit Component
Public Class ServiceController
Inherits Component
Public Class ServiceController
Implements IDisposable
Наследование
ServiceController
Наследование
ServiceController
Атрибуты
Реализации

Примеры

В следующем примере показано использование ServiceController класса для управления SimpleService примером службы.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
Imports System.ServiceProcess
Imports System.Diagnostics
Imports System.Threading



Class Program

    Public Enum SimpleServiceCustomCommands
        StopWorker = 128
        RestartWorker
        CheckWorker
    End Enum 'SimpleServiceCustomCommands

    Shared Sub Main(ByVal args() As String)
        Dim scServices() As ServiceController
        scServices = ServiceController.GetServices()

        Dim scTemp As ServiceController
        For Each scTemp In scServices

            If scTemp.ServiceName = "Simple Service" Then
                ' Display properties for the Simple Service sample 
                ' from the ServiceBase example
                Dim sc As New ServiceController("Simple Service")
                Console.WriteLine("Status = " + sc.Status.ToString())
                Console.WriteLine("Can Pause and Continue = " + _
                    sc.CanPauseAndContinue.ToString())
                Console.WriteLine("Can ShutDown = " + sc.CanShutdown.ToString())
                Console.WriteLine("Can Stop = " + sc.CanStop.ToString())
                If sc.Status = ServiceControllerStatus.Stopped Then
                    sc.Start()
                    While sc.Status = ServiceControllerStatus.Stopped
                        Thread.Sleep(1000)
                        sc.Refresh()
                    End While
                End If
                ' Issue custom commands to the service
                ' enum SimpleServiceCustomCommands 
                '    { StopWorker = 128, RestartWorker, CheckWorker };
                sc.ExecuteCommand(Fix(SimpleServiceCustomCommands.StopWorker))
                sc.ExecuteCommand(Fix(SimpleServiceCustomCommands.RestartWorker))
                sc.Pause()
                While sc.Status <> ServiceControllerStatus.Paused
                    Thread.Sleep(1000)
                    sc.Refresh()
                End While
                Console.WriteLine("Status = " + sc.Status.ToString())
                sc.Continue()
                While sc.Status = ServiceControllerStatus.Paused
                    Thread.Sleep(1000)
                    sc.Refresh()
                End While
                Console.WriteLine("Status = " + sc.Status.ToString())
                sc.Stop()
                While sc.Status <> ServiceControllerStatus.Stopped
                    Thread.Sleep(1000)
                    sc.Refresh()
                End While
                Console.WriteLine("Status = " + sc.Status.ToString())
                Dim argArray() As String = {"ServiceController arg1", "ServiceController arg2"}
                sc.Start(argArray)
                While sc.Status = ServiceControllerStatus.Stopped
                    Thread.Sleep(1000)
                    sc.Refresh()
                End While
                Console.WriteLine("Status = " + sc.Status.ToString())
                ' Display the event log entries for the custom commands
                ' and the start arguments.
                Dim el As New EventLog("Application")
                Dim elec As EventLogEntryCollection = el.Entries
                Dim ele As EventLogEntry
                For Each ele In elec
                    If ele.Source.IndexOf("SimpleService.OnCustomCommand") >= 0 Or ele.Source.IndexOf("SimpleService.Arguments") >= 0 Then
                        Console.WriteLine(ele.Message)
                    End If
                Next ele
            End If
        Next scTemp

    End Sub
End Class
' 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

Комментарии

Класс можно использовать ServiceController для подключения и управления поведением существующих служб.You can use the ServiceController class to connect to and control the behavior of existing services. При создании экземпляра ServiceController класса необходимо задать его свойства, чтобы он взаимодействовал с определенной службой Windows.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.

Скорее всего, компонент будет использоваться ServiceController в административной мощности.You will most likely use the ServiceController component in an administrative capacity. Например, можно создать веб-приложение Windows или, которое отправляет в службу пользовательские команды через ServiceController экземпляр.For example, you could create a Windows or Web application that sends custom commands to a service through the ServiceController instance. Это будет полезно, поскольку оснастка консоли управления (SCM) диспетчера управления службами не поддерживает пользовательские команды.This would be useful, because the Service Control Manager (SCM) Microsoft Management Console snap-in does not support custom commands.

После создания экземпляра ServiceController необходимо установить на нем два свойства, чтобы определить службу, с которой он взаимодействует: имя компьютера и имя службы, которую требуется контролировать.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.

Примечание

По умолчанию MachineName задается локальным компьютером, поэтому вам не нужно изменять его, если не нужно задавать экземпляр для указания другого компьютера.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. Например, служба может содержать код, отвечающий на ServiceBase.OnPause команду.For example, a service can contain code to respond to an ServiceBase.OnPause command. В этом случае пользовательская обработка Pause задачи выполняется до того, как система приостанавливает службу.In that case, the custom processing for the Pause task runs before the system pauses the service.

Набор команд, которые может обработать служба, зависит от ее свойств. Например, можно задать для CanStop Свойства службы значение false .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. Этот параметр отображает Stop команду, недоступную для данной службы. она не позволяет остановить службу из SCM, отключив необходимую кнопку.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. Если вы попытаетесь отключить службу из кода, система выдаст ошибку и выведет сообщение об ошибке "не удалось прерывать работу servicename ".If you try to stop the service from your code, the system raises an error and displays the error message "Failed to stop servicename."

Конструкторы

ServiceController()

Инициализирует новый экземпляр класса ServiceController, не связанный с конкретной службой.Initializes a new instance of the ServiceController class that is not associated with a specific service.

ServiceController(String)

Инициализирует новый экземпляр класса ServiceController, связанный с существующей службой на локальном компьютере.Initializes a new instance of the ServiceController class that is associated with an existing service on the local computer.

ServiceController(String, String)

Инициализирует новый экземпляр класса ServiceController, связанный с существующей службой на указанном компьютере.Initializes a new instance of the ServiceController class that is associated with an existing service on the specified computer.

Свойства

CanPauseAndContinue

Получает значение, показывающее, возможны ли приостановка и возобновление работы службы.Gets a value indicating whether the service can be paused and resumed.

CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Унаследовано от Component)
CanShutdown

Получает значение, показывающее, необходимо ли уведомлять службу о завершении работы системы.Gets a value indicating whether the service should be notified when the system is shutting down.

CanStop

Получает значение, определяющее, возможен ли останов службы после ее запуска.Gets a value indicating whether the service can be stopped after it has started.

Container

Возвращает объект IContainer, который содержит коллекцию Component.Gets the IContainer that contains the Component.

(Унаследовано от Component)
DependentServices

Получает набор служб, который зависит от службы, связанной с данным экземпляром ServiceController.Gets the set of services that depends on the service associated with this ServiceController instance.

DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Унаследовано от Component)
DisplayName

Получает или задает понятное имя службы.Gets or sets a friendly name for the service.

Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Унаследовано от Component)
MachineName

Получает или задает имя компьютера, на котором находится данная служба.Gets or sets the name of the computer on which this service resides.

ServiceHandle

Получает дескриптор службы.Gets the handle for the service.

ServiceName

Получает или задает имя, определяющее службу, на которую ссылается данный экземпляр.Gets or sets the name that identifies the service that this instance references.

ServicesDependedOn

Набор служб, от которых зависит данная служба.The set of services that this service depends on.

ServiceType

Получает тип службы, на которую ссылается данный объект.Gets the type of service that this object references.

Site

Получает или задает ISite объекта Component.Gets or sets the ISite of the Component.

(Унаследовано от Component)
StartType

Возвращает значение, указывающее способ запуска службы, представленной объектом ServiceController.Gets a value that indicates how the service represented by the ServiceController object starts.

Status

Получает состояние службы, на которую ссылается данный объект.Gets the status of the service that is referenced by this instance.

Методы

Close()

Отключает данный экземпляр ServiceController от службы и освобождает все выделенные ему ресурсы.Disconnects this ServiceController instance from the service and frees all the resources that the instance allocated.

Continue()

Возобновляет работу службы после ее приостановки.Continues a service after it has been paused.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Выполняет определяемые приложением задачи, связанные с удалением, высвобождением или сбросом неуправляемых ресурсов.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Dispose()

Освобождает все ресурсы, занятые модулем Component.Releases all resources used by the Component.

(Унаследовано от Component)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые объектом ServiceController, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the ServiceController and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
ExecuteCommand(Int32)

Выполняет пользовательскую команду для службы.Executes a custom command on the service.

GetDevices()

Загружает службы драйверов устройств на локальном компьютере.Retrieves the device driver services on the local computer.

GetDevices(String)

Загружает службы драйверов устройств на указанном компьютере.Retrieves the device driver services on the specified computer.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetService(Type)

Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container.Returns an object that represents a service provided by the Component or by its Container.

(Унаследовано от Component)
GetServices()

Загружает все службы на локальном компьютере, за исключением служб драйверов устройств.Retrieves all the services on the local computer, except for the device driver services.

GetServices(String)

Загружает все службы на указанном компьютере, за исключением служб драйверов устройств.Retrieves all the services on the specified computer, except for the device driver services.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
Pause()

Приостанавливает работу службы.Suspends a service's operation.

Refresh()

Обновляет значения свойств текущими значениями.Refreshes property values by resetting the properties to their current values.

Start()

Запускает службу без передачи аргументов.Starts the service, passing no arguments.

Start(String[])

Запускает службу, передавая заданные аргументы.Starts a service, passing the specified arguments.

Stop()

Останавливает данную службу и все зависящие от нее службы.Stops this service and any services that are dependent on this service.

ToString()

Возвращает объект String, содержащий имя Component, если оно есть.Returns a String containing the name of the Component, if any. Этот метод не следует переопределять.This method should not be overridden.

(Унаследовано от Component)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
WaitForStatus(ServiceControllerStatus)

Постоянно ожидает достижения службой указанного состояния.Infinitely waits for the service to reach the specified status.

WaitForStatus(ServiceControllerStatus, TimeSpan)

Ожидает достижения службой заданного состояния или истечения заданного тайм-аута.Waits for the service to reach the specified status or for the specified time-out to expire.

События

Disposed

Возникает при удалении компонента путем вызова метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Унаследовано от Component)

Применяется к

См. также раздел