php-doc-en/reference/win32service/functions/win32-delete-service.xml
Jakub Vrana e528224091 Fix return type
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201929 c90b9560-bf6c-de11-be94-00142212c4b1
2005-12-02 21:41:55 +00:00

111 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
<refentry id="function.win32-delete-service">
<refnamediv>
<refname>win32_delete_service</refname>
<refpurpose>Deletes a service entry from the SCM database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>win32_delete_service</methodname>
<methodparam><type>string</type><parameter>servicename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>machine</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to delete a service from the SCM database. Administrative
privileges are required for this to succeed.
</para>
<para>
This function really just marks the service for deletion. If other
processes (such as the Services Applet) are open, then the deletion will be
deferred until those applications are closed. If a service is marked for
deletion, further attempts to delete it will fail, and attempts to create a
new service with that name will also fail.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>servicename</parameter></term>
<listitem>
<para>
The short name of the service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>machine</parameter></term>
<listitem>
<para>
The optional machine name. If omitted, the local machine will be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success, or a win32 error code on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>win32_delete_service</function> example</title>
<para>
Deletes the dummyphp service.
</para>
<programlisting role="php">
<![CDATA[
<?php
win32_delete_service('dummyphp');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<!-- refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>win32_strerror</function></member>
</simplelist>
</para>
</refsect1 -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->