Php/docs/function.win32-send-custom-control
win32_send_custom_control
(PECL win32service >=0.4.0)
win32_send_custom_control — Send a custom control to the service
Description
win32_send_custom_control
( string $servicename
, int $control
[, string $machine
] ) : void
See » Microsoft ControlService function for more details
Parameters
servicename
- The short name of the service.
control
- The custom contole value between 128 and 255.
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
Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an
E_ERROR
level error.
A ValueError is thrown if the;
value of servicename
parameter is empty.
A ValueError is thrown if the;
value of control
parameter is not between 128 and 255.
A Win32ServiceException is thrown on error.
Changelog
Version | Description |
---|---|
PECL win32service 1.0.0 | Throws a ValueError on invalid data in parameters,
previously |
PECL win32service 1.0.0 | Throws a Win32ServiceException on error,
previously a Win32 Error Code was returned. |
PECL win32service 1.0.0 | The return type is now void, previously it was mixed. |
See Also
- win32_start_service() - Starts a service
- win32_stop_service() - Stops a service
- win32_pause_service() - Pauses a service
- win32_continue_service() - Resumes a paused service
- Win32 Error Codes