ServiceControl (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Operating mode
Limitation

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Functions for managing services

ServiceControl (Function)

In french: ServiceContrôle

Sends a control message to a service. This service can be found on the local computer or on a remote computer.

Versions 15 and later

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

New in version 15

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Example

// Pauses the service found in TABLE_Service
IF ServiceControl(COL_Name[TABLE_Service], serviceCmdPause) = False THEN
Error(ErrorInfo(errMessage))
END

Syntax

<Result> = ServiceControl(<Service name> , <Command to send> [, <Remote computer>])

<Result>: Boolean

True if the command was sent to the service manager,
False otherwise. To get the details of the error, use ErrorInfo.

<Service name>: Character string (with quotes)

Name of service to check.

<Command to send>: Integer constant or integer

Command that will be sent to the service:
serviceCmdStop Stops the service (equivalent to ServiceStop).
serviceCmdPause Pauses the service (equivalent to ServicePause).
serviceCmdRestart Restarts a service (equivalent to ServiceContinue).
serviceCmdRereadConfig Asks the service to re-read its configuration settings (equivalent to ServiceRefresh).
You also have the ability to use an integer included between 128 and 255. This range of values is intended for the commands defined by the service itself (see the documentation about the service for more details).

<Remote computer>: Optional character string (with quotes)

IP address of remote computer in xxx.xxx.xxx.xxx format (returned by NetIPAddress) or name of remote computer (returned by NetMachineName). This parameter is used to control a service on another computer. To use this option, the user must be administrator of remote computer.
If this parameter is not specified or if it corresponds to an empty string, the service is handled locally.

Remarks

Operating mode

ServiceControl sends a command to the service manager. This operation may not be performed immediately. To find out the status of the service, use ServiceWaitStatus.

Limitation

The functions for service management do not operate in the following operating systems: Windows 98 or Me.

Component: wd260std.dll