<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Queries the status of a service</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.win32-pause-service.html">win32_pause_service</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.win32-set-service-status.html">win32_set_service_status</a></div>
<div class="up"><a href="ref.win32service.html">win32service Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.win32-query-service-status" class="refentry">
<div class="refnamediv">
<h1 class="refname">win32_query_service_status</h1>
<p class="verinfo">(PECL win32service SVN)</p><p class="refpurpose"><span class="refname">win32_query_service_status</span> — <span class="dc-title">Queries the status of a service</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.win32-query-service-status-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>win32_query_service_status</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$servicename</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$machine</code></span>
] )</div>
<p class="para rdfs-comment">
Queries the current status for a service, returning an array of
information.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.win32-query-service-status-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">servicename</code></em></span>
<dd>
<p class="para">
The short name of the service.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">machine</code></em></span>
<dd>
<p class="para">
The optional machine name. If omitted, the local machine will be used.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.win32-query-service-status-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array consisting of the following information on success, <strong><code>FALSE</code></strong> if there is a problem with the parameters or a <a href="win32service.constants.errors.html" class="link">Win32 Error Code</a> on failure.
</p>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ServiceType</code></em></span>
<dd>
<p class="para">
The dwServiceType. See <a href="win32service.constants.servicetype.html" class="link">Win32Service Service Type Bitmasks</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">CurrentState</code></em></span>
<dd>
<p class="para">
The dwCurrentState. See <a href="win32service.constants.servicestatus.html" class="link">Win32Service Service Status Constants</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ControlsAccepted</code></em></span>
<dd>
<p class="para">
Which service controls are accepted by the service. See <a href="win32service.constants.controlsaccepted.html" class="link">Win32Service Service Control Message Accepted Bitmasks</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">Win32ExitCode</code></em></span>
<dd>
<p class="para">
If the service exited, the return code from the process.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ServiceSpecificExitCode</code></em></span>
<dd>
<p class="para">
If the service exited with an error condition, the service specific
code that is logged in the event log is visible here.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">CheckPoint</code></em></span>
<dd>
<p class="para">
If 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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">WaitHint</code></em></span>
<dd>
<p class="para">
If 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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ProcessId</code></em></span>
<dd>
<p class="para">
The Windows process identifier. If 0, the process is not running.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ServiceFlags</code></em></span>
<dd>
<p class="para">
The dwServiceFlags. See <a href="win32service.constants.serviceflag.html" class="link">Win32Service Service Service Flag Constants</a>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.win32-query-service-status-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="win32service.constants.html" class="link">Win32Service Predefined Constants</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.win32-pause-service.html">win32_pause_service</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.win32-set-service-status.html">win32_set_service_status</a></div>
<div class="up"><a href="ref.win32service.html">win32service Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
