ServiceController.ExecuteCommand(Int32) Method
Definition
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 -> unitPublic 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
An error occurred when accessing a system API.
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.
