win32_set_service_exit_mode
(PECL win32service >=0.4.0)
win32_set_service_exit_mode — Define or return the exit mode for the current running service
Description
$gracefulMode
= true): bool
If gracefulMode
parameter is provided, the exit mode
is changed. When the exit mode is not gracefuly, the exit code used can be set
with the win32_set_service_exit_code() function.
This function work only in "cli" SAPI. On other SAPI this function is disabled.
Parameters
-
gracefulMode
-
true
for exit graceful.false
for exit with error.
Return Values
Return the current or old exit mode.
Errors/Exceptions
Prior to version 1.0.0, if the SAPI is not "cli"
, this function emits an
E_ERROR
level error.
As of version 1.0.0, will throw a
Win32ServiceException if SAPI is not
"cli"
Changelog
Version | Description |
---|---|
PECL win32service 1.0.0 |
Throws a ValueError on invalid data in parameters,
previously false was returned.
|
PECL win32service 1.0.0 | Throws a Win32ServiceException on error, previously a Win32 Error Code was returned. |
See Also
- win32_start_service_ctrl_dispatcher() - Registers the script with the SCM, so that it can act as the service with the given name
- win32_set_service_status() - Update the service status
- win32_set_service_exit_code() - Define or return the exit code for the current running service