win32_query_service_status

win32_query_service_status

Queries the status of a service

array **win32_query_service_status** string $servicename string $machine

Queries the current status for a service, returning an array of information.

servicenameThe short name of the service.

machineThe optional machine name. If omitted, the local machine will be used.

Returns an array consisting of the following information on success

Prior version 1.0.0win32service.false.error

ServiceType The dwServiceType. See . Win32Service Service Type Bitmasks

CurrentState The dwCurrentState. See . Win32Service Service Status Constants

ControlsAccepted Which service controls are accepted by the service. See . Win32Service Service Control Message Accepted Bitmasks

Win32ExitCode If the service exited, the return code from the process. This value is equal to

   if the exit mode is not gracefuly. See 
    and 
   
  `WIN32_ERROR_SERVICE_SPECIFIC_ERROR`Win32Service error codes`win32_set_service_exit_mode`

ServiceSpecificExitCode If the service exited with an error condition, the service specific code that is logged in the event log is visible here. This value is equal to the value defined by win32_set_service_exit_code

CheckPointIf the service is shutting down, holds the current check point number. This is used by the SCM as a kind of heart-beat to detect a wedged service process. The value of the check point is best interpreted in conjunction with the WaitHint value.

WaitHintIf the service is shutting down it will set WaitHint to a checkpoint value that will indicate 100% completion. This can be used to implement a progress indicator.

ProcessIdThe Windows process identifier. If 0, the process is not running.

ServiceFlags The dwServiceFlags. See . Win32Service Service Flag Constants

A  is thrown if the
value of  parameter is empty.

ValueError``servicename

Win32Service Predefined Constants