Export (0) Print
Expand All

ServiceBase.OnCustomCommand Method

When implemented in a derived class, OnCustomCommand executes when the Service Control Manager (SCM) passes a custom command to the service. Specifies actions to take when a command with the specified parameter value occurs.

[Visual Basic]
Protected Overridable Sub OnCustomCommand( _
   ByVal command As Integer _
)
[C#]
protected virtual void OnCustomCommand(
 int command
);
[C++]
protected: virtual void OnCustomCommand(
 int command
);
[JScript]
protected function OnCustomCommand(
   command : int
);

Parameters

command
The command message sent to the service.

Remarks

OnCustomCommand lets you specify additional functionality beyond starting, stopping, pausing and continuing services.

The SCM does not examine the custom command to verify whether the service supports the command parameter passed in. It passes the custom command directly to the service. If the service does not recognize the command parameter, it does nothing.

Custom commands are raised by an ExecuteCommand statement in a ServiceController component. Use a switch statement or if..then condition to handle the custom commands you define on your service.

The only values for a custom command that you can define in your application or use in OnCustomCommand are those between 128 and 256. Integers below 128 correspond to system-reserved values.

If the AutoLog property is true, custom commands, like all other commands, write entries to the event log to report whether the method execution succeeded or failed.

Requirements

Platforms: Windows NT Server 4.0, Windows NT Workstation 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

ServiceBase Class | ServiceBase Members | System.ServiceProcess Namespace | OnContinue | OnPause | OnPowerEvent | OnShutdown | OnStart | OnStop

Show:
© 2014 Microsoft