<!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>Update the service status</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.win32-query-service-status.html">win32_query_service_status</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.win32-start-service-ctrl-dispatcher.html">win32_start_service_ctrl_dispatcher</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-set-service-status" class="refentry">
<div class="refnamediv">
<h1 class="refname">win32_set_service_status</h1>
<p class="verinfo">(PECL win32service SVN)</p><p class="refpurpose"><span class="refname">win32_set_service_status</span> — <span class="dc-title">Update the service status</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.win32-set-service-status-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>win32_set_service_status</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$status</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$checkpoint</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Informs the SCM of the current status of a running service.
This call is only valid for a running service process.
</p>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI
this function is disabled.
</p>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.win32-set-service-status-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">status</code></dt>
<dd>
<p class="para">
The service status code, one of
<strong><code>WIN32_SERVICE_RUNNING</code></strong>,
<strong><code>WIN32_SERVICE_STOPPED</code></strong>,
<strong><code>WIN32_SERVICE_STOP_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_START_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_CONTINUE_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_PAUSE_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_PAUSED</code></strong>.
</p>
</dd>
<dt>
<code class="parameter">checkpoint</code></dt>
<dd>
<p class="para">
The checkpoint value the service increments periodically to report its
progress during a lengthy start, stop, pause, or continue operation.
For example, the service should increment this value as it completes
each step of its initialization when it is starting up.
</p>
<p class="para">
The <code class="parameter">checkpoint</code> is only valid when the
<code class="parameter">status</code> is one of
<strong><code>WIN32_SERVICE_STOP_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_START_PENDING</code></strong>,
<strong><code>WIN32_SERVICE_CONTINUE_PENDING</code></strong> or
<strong><code>WIN32_SERVICE_PAUSE_PENDING</code></strong>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.win32-set-service-status-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> 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>
</div>
<div class="refsect1 changelog" id="refsect1-function.win32-set-service-status-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>0.2.0</td>
<td>
This function works only in the <em>"cli"</em> SAPI.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.win32-set-service-status-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.win32-start-service-ctrl-dispatcher.html" class="function" rel="rdfs-seeAlso">win32_start_service_ctrl_dispatcher()</a> - Registers the script with the SCM, so that it can act as the service with the given name</span></li>
<li class="member"><span class="function"><a href="function.win32-get-last-control-message.html" class="function" rel="rdfs-seeAlso">win32_get_last_control_message()</a> - Returns the last control message that was sent to this service</span></li>
<li class="member"><a href="win32service.constants.servicestatus.html" class="link">Win32Service Service Status 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-query-service-status.html">win32_query_service_status</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.win32-start-service-ctrl-dispatcher.html">win32_start_service_ctrl_dispatcher</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>
