Stop Service

Stops a Windows service according to the name.

Command availability: IBM RPA SaaS and IBM RPA on premises

Description

Stops a Windows service according to the name.

Note:Windows services 🡥 are applications that run in the background and they can be automatically started when Windows starts.

Script syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

stopService --name(String) (Boolean)=value

Input parameters

The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.

Designer mode label Script mode name Required Accepted variable types Description
Service Name name Required Text Name of the service that should be stopped.

Output parameters

Designer mode label Script mode name Accepted variable types Description
Result value Boolean Returns true if the service is successfully stopped, otherwise returns false.

Example

The command stops a Windows service whose name is "wuauserv" (Windows Update).

defVar --name stopSuccess --type Boolean
stopService --name wuauserv stopSuccess=value
logMessage --message "Result: ${stopSuccess}" --type "Info"
Note:The output value depends on the existence of the application installed on the Windows device.

Limitations

Use the service name instead of the service display name for commands that handle Windows service. Ex: Use IBMAUTService and not the display name which is IBM Auto Update Service.