This documentation is archived and is not being maintained.

ServiceController.ExecuteCommand Method

Executes a custom command on the service.

Namespace:  System.ServiceProcess
Assembly:  System.ServiceProcess (in System.ServiceProcess.dll)

'Declaration
Public Sub ExecuteCommand ( _
	command As Integer _
)
'Usage
Dim instance As ServiceController 
Dim command As Integer

instance.ExecuteCommand(command)

Parameters

command
Type: System.Int32

An application-defined command flag that indicates which custom command to execute. The value must be equal to or larger than 128, and equal to or less than 256.

ExceptionCondition
Win32Exception

An error occurred when accessing a system API.

InvalidOperationException

The service was not found.

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.

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

Imports System
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 'Main 
End Class 'Program 

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: