anx.framework/lib/nant-0.91/doc/help/tasks/servicecontroller.html
Glatzemann 39dc83d33e added NAnt 0.91 build system to the lib folder
added build folder
added build script for release build of ANX.Framework and all RenderSystems
fixed some issues in projects regarding compiler directives
removed StockShaderCodeGenerator from Pre-Build-Events. Build the Stock shaders using NAnt target build_stock_shaders.
started Wiki documentation for custom build switches (e.g. extended mode)
2011-11-18 11:04:26 +00:00

109 lines
4.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Documenting T:NAnt.MSNet.Tasks.ServiceControllerTask-->
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>&lt;servicecontroller&gt; Task</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a href="http://nant.sourceforge.net">
<b>NAnt</b>
</a>
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../tasks/index.html">Task Reference</a>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;servicecontroller&gt;</td>
<td class="NavBar-Cell" align="right">
v0.91</td>
</tr>
</table>
<h1>&lt;servicecontroller&gt;</h1>
<p> Allows a Windows service to be controlled. </p>
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Attribute</th>
<th style="text-align: center;">Type</th>
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top" class="required">action</td>
<td style="text-align: center;">
<a href="../enums/NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.html">ActionType</a>
</td>
<td> The action that should be performed on the service. </td>
<td style="text-align: center;">True</td>
</tr>
<tr>
<td valign="top" class="required">service</td>
<td style="text-align: center;">string</td>
<td> The name of the service that should be controlled. </td>
<td style="text-align: center;">True</td>
</tr>
<tr>
<td valign="top">machine</td>
<td style="text-align: center;">string</td>
<td> The name of the computer on which the service resides. The default is the local computer. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">timeout</td>
<td style="text-align: center;">double</td>
<td> The time, in milliseconds, the task will wait for the service to reach the desired status. The default is 5000 milliseconds. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td style="text-align: center;">bool</td>
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">if</td>
<td style="text-align: center;">bool</td>
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">unless</td>
<td style="text-align: center;">bool</td>
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td style="text-align: center;">bool</td>
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Examples</h3>
<ul class="examples">
<li>
<p>Starts the World Wide Web Publishing Service on the local computer.</p>
<pre class="code">
&lt;servicecontroller action="Start" service="w3svc" /&gt;
</pre>
</li>
<li>
<p>Stops the Alerter service on computer 'MOTHER'.</p>
<pre class="code">
&lt;servicecontroller action="Stop" service="Alerter" machine="MOTHER" /&gt;
</pre>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.MSNetTasks (0.91.4312.0)
</div>
</body>
</html>