Source of: /manual/en/function.win32-set-service-status.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.win32service.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.win32-set-service-status.php',
1 => 'win32_set_service_status',
),
'up' =>
array (
0 => 'ref.win32service.php',
1 => 'win32service Functions',
),
'prev' =>
array (
0 => 'function.win32-query-service-status.php',
1 => 'win32_query_service_status',
),
'next' =>
array (
0 => 'function.win32-start-service-ctrl-dispatcher.php',
1 => 'win32_start_service_ctrl_dispatcher',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.win32-set-service-status.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>win32_set_service_status</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$status</tt></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>
<a name="function.win32-set-service-status.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">status</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The service status code, one of
<b><tt class="constant">WIN32_SERVICE_RUNNING</tt></b>,
<b><tt class="constant">WIN32_SERVICE_STOPPED</tt></b>,
<b><tt class="constant">WIN32_SERVICE_STOP_PENDING</tt></b>,
<b><tt class="constant">WIN32_SERVICE_START_PENDING</tt></b>,
<b><tt class="constant">WIN32_SERVICE_CONTINUE_PENDING</tt></b>,
<b><tt class="constant">WIN32_SERVICE_PAUSE_PENDING</tt></b>,
<b><tt class="constant">WIN32_SERVICE_PAUSED</tt></b>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.win32-set-service-status.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.win32-set-service-status.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.win32-start-service-ctrl-dispatcher.php" 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</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
