ServiceController.ExecuteCommand(Int32) Method

Reference

Definition

Namespace:: System.ServiceProcess

Assembly:: System.ServiceProcess.ServiceController.dll

Assembly:: System.ServiceProcess.dll

Package:: System.ServiceProcess.ServiceController v10.0.0-preview.1.25080.5

Source:: ServiceController.cs

Source:: ServiceController.cs

Source:: ServiceController.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Executes a custom command on the service.

public:
 void ExecuteCommand(int command);

public void ExecuteCommand(int command);

member this.ExecuteCommand : int -> unit

Public Sub ExecuteCommand (command As Integer)

Parameters

command: Int32

An application-defined command flag that indicates which custom command to execute. The value must be between 128 and 256, inclusive.

Exceptions

Win32Exception

An error occurred when accessing a system API.

InvalidOperationException

The service was not found.

Examples

The following code example shows the use of the ServiceController.ExecuteCommand(Int32) method to execute custom commands in the SimpleService service example.

using System;
using System.ServiceProcess;

namespace test_exec_cmnd
{
    class Program
    {
        private enum SimpleServiceCustomCommands { StopWorker = 128, RestartWorker, CheckWorker };
        static void Main(string[] args)
        {
            ServiceController myService = new ServiceController("SimpleService");
            myService.ExecuteCommand((int)SimpleServiceCustomCommands.StopWorker);
            myService.ExecuteCommand((int)SimpleServiceCustomCommands.RestartWorker);
            myService.ExecuteCommand((int)SimpleServiceCustomCommands.CheckWorker);
        }
    }
}

Imports System.ServiceProcess



Class Program
    
    Private Enum SimpleServiceCustomCommands
        StopWorker = 128
        RestartWorker
        CheckWorker '
    End Enum 'SimpleServiceCustomCommands

    Shared Sub Main(ByVal args() As String) 
        Dim myService As New ServiceController("SimpleService")
        myService.ExecuteCommand(Fix(SimpleServiceCustomCommands.StopWorker))
        myService.ExecuteCommand(Fix(SimpleServiceCustomCommands.RestartWorker))
        myService.ExecuteCommand(Fix(SimpleServiceCustomCommands.CheckWorker))
    
    End Sub
End Class

Remarks

When you call ExecuteCommand, the status of the service does not change. If the service was started, the status remains Running. If the service was stopped, the status remains Stopped, and so on. To process the custom command, the service must override the OnCustomCommand method and provide a handler for the command identified by the command parameter.

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via