win32_pause_service

(PECL win32service >=0.1.0)

win32_pause_service — Pauses a service

Description

win32_pause_service(string $servicename, string $machine = null): void

Pauses a named service. Requires administrative privileges or an account with appropriate rights set in the service's ACL.

Parameters

servicename

The short name of the service.

machine

Optional machine name. If omitted, the local machine is used.

Return Values

No value is returned.

Prior to version 1.0.0, returned WIN32_NO_ERROR on success, false if there is a problem with the parameters or a Win32 Error Code on failure.

Errors/Exceptions

A ValueError is thrown if the value of servicename parameter is empty.

A Win32ServiceException is thrown on error.

Changelog

VersionDescription
PECL win32service 1.0.0Throws a ValueError on invalid data in parameters, previously false was returned.
PECL win32service 1.0.0Throws a Win32ServiceException on error, previously a Win32 Error Code was returned.
PECL win32service 1.0.0The return type is now void, previously it was mixed.
PECL win32service 0.3.0This function does not longer require an administrator account if ACL is set for another account.

See Also