ServiceController Klasse

Definition

Stellt einen Windows-Dienst dar und ermöglicht es, eine Verbindung mit einem ausgeführten oder beendeten Dienst herzustellen, ihn zu verändern oder Informationen über ihn abzurufen.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
Public Class ServiceController
Inherits Component
Public Class ServiceController
Implements IDisposable
Vererbung
ServiceController
Vererbung
ServiceController
Attribute

Beispiele

Im folgenden Beispiel wird die Verwendung der ServiceController-Klasse zum Steuern des SimpleService Dienst Beispiels veranschaulicht.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

Hinweise

Sie können die ServiceController-Klasse zum Herstellen einer Verbindung mit und zum Steuern des Verhaltens vorhandener Dienste verwenden.You can use the ServiceController class to connect to and control the behavior of existing services. Wenn Sie eine Instanz der ServiceController-Klasse erstellen, legen Sie die zugehörigen Eigenschaften so fest, dass Sie mit einem bestimmten Windows-Dienst interagiert.When you create an instance of the ServiceController class, you set its properties so it interacts with a specific Windows service. Anschließend können Sie die-Klasse verwenden, um den Dienst zu starten, zu unterbinden und anderweitig zu bearbeiten.You can then use the class to start, stop, and otherwise manipulate the service.

Sie werden wahrscheinlich die ServiceController Komponente in einer administrativen Kapazität verwenden.You will most likely use the ServiceController component in an administrative capacity. Beispielsweise können Sie eine Windows-oder eine Webanwendung erstellen, die benutzerdefinierte Befehle über die ServiceController Instanz an einen Dienst sendet.For example, you could create a Windows or Web application that sends custom commands to a service through the ServiceController instance. Dies ist hilfreich, da das Microsoft Management Console-Snap-in "Service Control Manager (SCM)" keine benutzerdefinierten Befehle unterstützt.This would be useful, because the Service Control Manager (SCM) Microsoft Management Console snap-in does not support custom commands.

Nachdem Sie eine Instanz von ServiceControllererstellt haben, müssen Sie zwei Eigenschaften festlegen, um den Dienst zu identifizieren, mit dem Sie interagiert: den Computernamen und den Namen des Dienstanbieter, den Sie steuern möchten.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.

Hinweis

Standardmäßig ist MachineName auf den lokalen Computer festgelegt, sodass Sie Sie nicht ändern müssen, es sei denn, Sie möchten festlegen, dass die Instanz auf einen anderen Computer verweist.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.

Im Allgemeinen schreibt der Dienst Autor Code, der die Aktion anpasst, die einem bestimmten Befehl zugeordnet ist.Generally, the service author writes code that customizes the action associated with a specific command. Ein Dienst kann z. b. Code enthalten, der auf einen ServiceBase.OnPause Befehl antwortet.For example, a service can contain code to respond to an ServiceBase.OnPause command. In diesem Fall wird die benutzerdefinierte Verarbeitung für den Pause Task ausgeführt, bevor das System den Dienst anhält.In that case, the custom processing for the Pause task runs before the system pauses the service.

Der Satz von Befehlen, der von einem Dienst verarbeitet werden kann, hängt von seinen Eigenschaften ab. Beispielsweise können Sie die CanStop-Eigenschaft für einen Dienst auf falsefestlegen.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. Diese Einstellung rendert den Stop Befehl, der für den jeweiligen Dienst nicht verfügbar ist. Dadurch wird verhindert, dass Sie den Dienst über den SCM beenden, indem Sie die erforderliche Schaltfläche deaktivieren.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. Wenn Sie versuchen, den Dienst aus Ihrem Code zu beenden, löst das System einen Fehler aus und zeigt die Fehlermeldung "Fehler beim Beenden des servicename" an.If you try to stop the service from your code, the system raises an error and displays the error message "Failed to stop servicename."

Konstruktoren

ServiceController()

Initialisiert eine neue Instanz der ServiceController-Klasse, die keinem bestimmten Dienst zugeordnet ist.Initializes a new instance of the ServiceController class that is not associated with a specific service.

ServiceController(String)

Initialisiert eine neue Instanz der ServiceController-Klasse, die einem vorhandenen Dienst auf dem lokalen Computer zugeordnet ist.Initializes a new instance of the ServiceController class that is associated with an existing service on the local computer.

ServiceController(String, String)

Initialisiert eine neue Instanz der ServiceController-Klasse, die einem vorhandenen Dienst auf dem angegebenen Computer zugeordnet ist.Initializes a new instance of the ServiceController class that is associated with an existing service on the specified computer.

Eigenschaften

CanPauseAndContinue

Ruft einen Wert ab, der angibt, ob der Dienst angehalten und fortgesetzt werden kann.Gets a value indicating whether the service can be paused and resumed.

CanRaiseEvents

Ruft einen Wert ab, der angibt, ob die Komponente ein Ereignis auslösen kann.Gets a value indicating whether the component can raise an event.

(Geerbt von Component)
CanShutdown

Ruft einen Wert ab, der angibt, ob der Dienst beim Herunterfahren des Systems benachrichtigt werden soll.Gets a value indicating whether the service should be notified when the system is shutting down.

CanStop

Ruft einen Wert ab, der angibt, ob der Dienst nach dem Starten angehalten werden kann.Gets a value indicating whether the service can be stopped after it has started.

Container

Ruft die IContainer ab, die in der Component enthalten ist.Gets the IContainer that contains the Component.

(Geerbt von Component)
DependentServices

Ruft die Gruppe von Diensten ab, die von dem Dienst abhängen, der dieser ServiceController-Instanz zugeordnet ist.Gets the set of services that depends on the service associated with this ServiceController instance.

DesignMode

Ruft einen Wert ab, der angibt, ob sich Component gegenwärtig im Entwurfsmodus befindet.Gets a value that indicates whether the Component is currently in design mode.

(Geerbt von Component)
DisplayName

Ruft einen angezeigten Namen für den Dienst ab oder richtet ihn ein.Gets or sets a friendly name for the service.

Events

Ruft die Liste der Ereignishandler ab, die dieser Component angefügt sind.Gets the list of event handlers that are attached to this Component.

(Geerbt von Component)
MachineName

Ruft den Namen des Computers ab, auf dem sich dieser Dienst befindet, oder legt diesen fest.Gets or sets the name of the computer on which this service resides.

ServiceHandle

Ruft das Handle für den Dienst ab.Gets the handle for the service.

ServiceName

Ruft den Namen ab, der den Dienst identifiziert, auf den diese Instanz verweist, oder richtet diesen Namen ein.Gets or sets the name that identifies the service that this instance references.

ServicesDependedOn

Die Gruppe von Diensten, von denen dieser Dienst abhängig ist.The set of services that this service depends on.

ServiceType

Ruft den Typ des Diensts ab, auf den dieses Objekt verweist.Gets the type of service that this object references.

Site

Ruft den ISite von Component ab oder legt ihn fest.Gets or sets the ISite of the Component.

(Geerbt von Component)
StartType

Ruft einen Wert ab, der angibt, wie der vom ServiceController-Objekt angegebene Dienst gestartet wird.Gets a value that indicates how the service represented by the ServiceController object starts.

Status

Ruft den Zustand des Diensts ab, auf den diese Instanz verweist.Gets the status of the service that is referenced by this instance.

Methoden

Close()

Trennt diese ServiceController-Instanz vom Dienst und gibt alle Ressourcen frei, die durch die Instanz reserviert wurden.Disconnects this ServiceController instance from the service and frees all the resources that the instance allocated.

Continue()

Setzt einen Dienst fort, nachdem dieser angehalten wurde.Continues a service after it has been paused.

CreateObjRef(Type)

Erstellt ein Objekt mit allen relevanten Informationen, die zum Generieren eines Proxys für die Kommunikation mit einem Remoteobjekt erforderlich sind.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Geerbt von MarshalByRefObject)
Dispose()
Dispose(Boolean)

Gibt die von ServiceController verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.Releases the unmanaged resources used by the ServiceController and optionally releases the managed resources.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
ExecuteCommand(Int32)

Führt einen benutzerdefinierten Befehl für den Dienst aus.Executes a custom command on the service.

GetDevices()

Ruft die Gerätetreiberdienste auf dem lokalen Computer ab.Retrieves the device driver services on the local computer.

GetDevices(String)

Ruft die Gerätetreiberdienste auf dem angegebenen Computer ab.Retrieves the device driver services on the specified computer.

GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetLifetimeService()

Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinien für diese Instanz steuert.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
GetService(Type)

Gibt ein Objekt zurück, das einen von der Component oder von deren Container bereitgestellten Dienst darstellt.Returns an object that represents a service provided by the Component or by its Container.

(Geerbt von Component)
GetServices()

Ruft alle Dienste auf dem lokalen Computer mit Ausnahme der Gerätetreiberdienste ab.Retrieves all the services on the local computer, except for the device driver services.

GetServices(String)

Ruft alle Dienste auf dem angegebenen Computer mit Ausnahme der Gerätetreiberdienste ab.Retrieves all the services on the specified computer, except for the device driver services.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
InitializeLifetimeService()

Ruft ein Lebensdauerdienstobjekt zur Steuerung der Lebensdauerrichtlinie für diese Instanz ab.Obtains a lifetime service object to control the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
MemberwiseClone(Boolean)

Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts.Creates a shallow copy of the current MarshalByRefObject object.

(Geerbt von MarshalByRefObject)
Pause()

Unterbricht die Ausführung eines Diensts.Suspends a service's operation.

Refresh()

Aktualisiert Eigenschaftswerte durch Zurücksetzen der Eigenschaften auf ihre aktuellen Werte.Refreshes property values by resetting the properties to their current values.

Start()

Startet den Dienst und übergibt dabei keine Argumente.Starts the service, passing no arguments.

Start(String[])

Startet einen Dienst und übergibt dabei die angegebenen Argumente.Starts a service, passing the specified arguments.

Stop()

Beendet diesen Dienst sowie alle Dienste, die von diesem Dienst abhängig sind.Stops this service and any services that are dependent on this service.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)
WaitForStatus(ServiceControllerStatus)

Wartet unbegrenzt, bis der Dienst den angegebenen Zustand annimmt.Infinitely waits for the service to reach the specified status.

WaitForStatus(ServiceControllerStatus, TimeSpan)

Wartet, bis der Dienst den angegebenen Status annimmt oder bis das angegebene Timeout abläuft.Waits for the service to reach the specified status or for the specified time-out to expire.

Ereignisse

Disposed

Tritt auf, wenn die Komponente von einem Aufruf der Dispose()-Methode verworfen wird.Occurs when the component is disposed by a call to the Dispose() method.

(Geerbt von Component)

Gilt für:

Siehe auch