ServiceController Clase

Definición

Representa un servicio de Windows y permite conectarse a un servicio en ejecución o detenido, manipularlo u obtener información sobre él.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
[System.ServiceProcess.ServiceProcessDescription("ServiceControllerDesc")]
public class ServiceController : System.ComponentModel.Component
type ServiceController = class
    inherit Component
Public Class ServiceController
Inherits Component
Herencia
ServiceController
Atributos

Ejemplos

En el ejemplo siguiente se muestra el uso ServiceController de la clase para SimpleService controlar el ejemplo de servicio.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

Comentarios

Puede utilizar la ServiceController clase para conectarse y controlar el comportamiento de los servicios existentes.You can use the ServiceController class to connect to and control the behavior of existing services. Cuando se crea una instancia de la ServiceController clase, se establecen sus propiedades para que interactúe con un servicio de Windows específico.When you create an instance of the ServiceController class, you set its properties so it interacts with a specific Windows service. A continuación, puede utilizar la clase para iniciar, detener o manipular el servicio de otra manera.You can then use the class to start, stop, and otherwise manipulate the service.

Lo más probable es que use ServiceController el componente en una capacidad administrativa.You will most likely use the ServiceController component in an administrative capacity. Por ejemplo, puede crear una aplicación de Windows o web que envíe comandos personalizados a un servicio a través ServiceController de la instancia de.For example, you could create a Windows or Web application that sends custom commands to a service through the ServiceController instance. Esto resultaría útil, ya que el complemento Administrador de control de servicios (SCM) de Microsoft Management Console no es compatible con comandos personalizados.This would be useful, because the Service Control Manager (SCM) Microsoft Management Console snap-in does not support custom commands.

Después de crear una instancia de ServiceController, debe establecer dos propiedades en ella para identificar el servicio con el que interactúa: el nombre del equipo y el nombre del servicio que desea controlar.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.

Nota

De forma predeterminada MachineName , se establece en el equipo local, por lo que no es necesario cambiarla a menos que desee establecer la instancia para que apunte a otro equipo.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.

Por lo general, el autor del servicio escribe código que personaliza la acción asociada a un comando específico.Generally, the service author writes code that customizes the action associated with a specific command. Por ejemplo, un servicio puede contener código para responder a un ServiceBase.OnPause comando.For example, a service can contain code to respond to an ServiceBase.OnPause command. En ese caso, el procesamiento personalizado de la Pause tarea se ejecuta antes de que el sistema pausa el servicio.In that case, the custom processing for the Pause task runs before the system pauses the service.

El conjunto de comandos que un servicio puede procesar depende de sus propiedades; por ejemplo, puede establecer la CanStop propiedad de un servicio en. falseThe set of commands a service can process depends on its properties; for example, you can set the CanStop property for a service to false. Esta configuración representa el Stop comando no disponible en ese servicio concreto; impide detener el servicio desde el SCM deshabilitando el botón necesario.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. Si intenta detener el servicio desde el código, el sistema genera un error y muestra el mensaje de error "no se pudo detener 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."

Constructores

ServiceController()

Inicializa una nueva instancia de la clase ServiceController que no está asociada a un servicio determinado.Initializes a new instance of the ServiceController class that is not associated with a specific service.

ServiceController(String)

Inicializa una nueva instancia de la clase ServiceController que está asociada a un servicio existente en el equipo local.Initializes a new instance of the ServiceController class that is associated with an existing service on the local computer.

ServiceController(String, String)

Inicializa una nueva instancia de la clase ServiceController que está asociada a un servicio existente en el equipo especificado.Initializes a new instance of the ServiceController class that is associated with an existing service on the specified computer.

Propiedades

CanPauseAndContinue

Obtiene un valor que indica si se puede pausar y reanudar el servicio.Gets a value indicating whether the service can be paused and resumed.

CanRaiseEvents

Obtiene un valor que indica si el componente puede generar un evento.Gets a value indicating whether the component can raise an event.

(Heredado de Component)
CanShutdown

Obtiene un valor que indica si se debe notificar al servicio cuando se está cerrando el sistema.Gets a value indicating whether the service should be notified when the system is shutting down.

CanStop

Obtiene un valor que indica si el servicio puede detenerse después de haberse iniciado.Gets a value indicating whether the service can be stopped after it has started.

Container

Obtiene IContainer que contiene Component.Gets the IContainer that contains the Component.

(Heredado de Component)
DependentServices

Obtiene el conjunto de servicios que depende del servicio asociado a esta instancia ServiceController.Gets the set of services that depends on the service associated with this ServiceController instance.

DesignMode

Obtiene un valor que indica si Component está actualmente en modo de diseño.Gets a value that indicates whether the Component is currently in design mode.

(Heredado de Component)
DisplayName

Obtiene o establece un nombre descriptivo para el servicio.Gets or sets a friendly name for the service.

Events

Obtiene la lista de controladores de eventos asociados a Component.Gets the list of event handlers that are attached to this Component.

(Heredado de Component)
MachineName

Obtiene o establece el nombre del equipo en el que reside el servicio.Gets or sets the name of the computer on which this service resides.

ServiceHandle

Obtiene el identificador del servicio.Gets the handle for the service.

ServiceName

Obtiene o establece el nombre que identifica el servicio al que hace referencia esta instancia.Gets or sets the name that identifies the service that this instance references.

ServicesDependedOn

Conjunto de servicios de los que depende este servicio.The set of services that this service depends on.

ServiceType

Obtiene el tipo de servicio al que hace referencia este objeto.Gets the type of service that this object references.

Site

Obtiene o establece el ISite de Component.Gets or sets the ISite of the Component.

(Heredado de Component)
StartType

Obtiene un valor que indica cómo se inicia el servicio representado por el objeto ServiceController.Gets a value that indicates how the service represented by the ServiceController object starts.

Status

Obtiene el estado del servicio al que hace referencia esta instancia.Gets the status of the service that is referenced by this instance.

Métodos

Close()

Desconecta esta instancia de ServiceController desde el servicio y libera todos los recursos que asignó la instancia.Disconnects this ServiceController instance from the service and frees all the resources that the instance allocated.

Continue()

Reanuda un servicio después de que se haya dejado en pausa.Continues a service after it has been paused.

CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Heredado de MarshalByRefObject)
Dispose()
Dispose(Boolean)

Libera los recursos no administrados que usa ServiceController y, de forma opcional, libera los recursos administrados.Releases the unmanaged resources used by the ServiceController and optionally releases the managed resources.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
ExecuteCommand(Int32)

Ejecuta un comando personalizado en el servicio.Executes a custom command on the service.

GetDevices()

Recupera los servicios del controlador de dispositivos en el equipo local.Retrieves the device driver services on the local computer.

GetDevices(String)

Recupera los servicios del controlador de dispositivos en el equipo especificado.Retrieves the device driver services on the specified computer.

GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
GetService(Type)

Devuelve un objeto que representa el servicio suministrado por Component o por Container.Returns an object that represents a service provided by the Component or by its Container.

(Heredado de Component)
GetServices()

Recupera todos los servicios del equipo local, excepto los servicios de controlador de dispositivos.Retrieves all the services on the local computer, except for the device driver services.

GetServices(String)

Recupera todos los servicios del equipo especificado, excepto los servicios de controlador de dispositivos.Retrieves all the services on the specified computer, except for the device driver services.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
InitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

(Heredado de MarshalByRefObject)
Pause()

Suspende la operación de un servicio.Suspends a service's operation.

Refresh()

Actualiza los valores de propiedades y las restablece en sus valores actuales.Refreshes property values by resetting the properties to their current values.

Start()

Inicia el servicio sin pasar argumentos.Starts the service, passing no arguments.

Start(String[])

Inicia un servicio y pasa los argumentos especificados.Starts a service, passing the specified arguments.

Stop()

Detiene este servicio y todos los servicios que dependan de él.Stops this service and any services that are dependent on this service.

ToString()

Devuelve una String que contiene el nombre del Component, si existe.Returns a String containing the name of the Component, if any. Este método no se debe invalidar.This method should not be overridden.

(Heredado de Component)
WaitForStatus(ServiceControllerStatus)

No actúa hasta que el servicio alcanza el estado especificado.Infinitely waits for the service to reach the specified status.

WaitForStatus(ServiceControllerStatus, TimeSpan)

Espera a que el servicio alcance el estado especificado o a que expire el tiempo de espera especificado.Waits for the service to reach the specified status or for the specified time-out to expire.

Eventos

Disposed

Se produce cuando el componente se elimina mediante una llamada al método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Heredado de Component)

Se aplica a

Consulte también: