win32_get_last_control_message
Returns the last control message that was sent to this service
Description
Returns the control code that was last sent to this service process. When running as a service you should periodically check this to determine if your service needs to stop running.
Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI this function is disabled.
Parameters Parameters
Return Values
Returns a control constant which will be one of the Win32Service Service Control Message Constants: WIN32_SERVICE_CONTROL_CONTINUE, WIN32_SERVICE_CONTROL_DEVICEEVENT, WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE, WIN32_SERVICE_CONTROL_INTERROGATE, WIN32_SERVICE_CONTROL_NETBINDADD, WIN32_SERVICE_CONTROL_NETBINDDISABLE, WIN32_SERVICE_CONTROL_NETBINDENABLE, WIN32_SERVICE_CONTROL_NETBINDREMOVE, WIN32_SERVICE_CONTROL_PARAMCHANGE, WIN32_SERVICE_CONTROL_PAUSE, WIN32_SERVICE_CONTROL_POWEREVENT, WIN32_SERVICE_CONTROL_PRESHUTDOWN, WIN32_SERVICE_CONTROL_SESSIONCHANGE, WIN32_SERVICE_CONTROL_SHUTDOWN, WIN32_SERVICE_CONTROL_STOP.
If the value is between 128 and 255, the control code is custom.
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. |
| PECL win32service 0.2.0 | This function works only in the "cli" SAPI. |