ExecuteCommand Method
Collapse the table of content
Expand the table of content

ServiceController.ExecuteCommand Method (Int32)

 

Executes a custom command on the service.

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

Public Sub ExecuteCommand (
	command As Integer
)

Parameters

command
Type: System.Int32

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

Exception Condition
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.

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 

ServiceControllerPermission

for controlling services on the computer. Associated enumeration: ServiceControllerPermissionAccess.Control

SecurityPermission

for unrestricted access to service information. Associated enumeration: PermissionState.Unrestricted

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft