mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
156 lines
4.4 KiB
XML
156 lines
4.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.win32-send-custom-control" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>win32_send_custom_control</refname>
|
|
<refpurpose>Send a custom control to the service</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description"><!-- {{{ -->
|
|
&reftitle.description;
|
|
<methodsynopsis role="procedural">
|
|
<type>void</type><methodname>win32_send_custom_control</methodname>
|
|
<methodparam><type>string</type><parameter>servicename</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>control</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>machine</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
|
|
See <link xlink:href="&url.microsoft.controlservice;">Microsoft ControlService function</link> for more details
|
|
</para>
|
|
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="parameters"><!-- {{{ -->
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>servicename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The short name of the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>control</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The custom contole value between 128 and 255.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>machine</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Optional machine name. If omitted, the local machine is used.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="returnvalues"><!-- {{{ -->
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
<para>
|
|
Prior to version 1.0.0, &win32service.noerror.false.error;
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="errors"><!-- {{{ -->
|
|
&reftitle.errors;
|
|
<para>
|
|
Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an
|
|
<constant>E_ERROR</constant> level error.
|
|
</para>
|
|
<para>
|
|
A <classname>ValueError</classname> is thrown if the
|
|
value of <parameter>servicename</parameter> parameter is empty.
|
|
</para>
|
|
<para>
|
|
A <classname>ValueError</classname> is thrown if the
|
|
value of <parameter>control</parameter> parameter is not between 128 and 255.
|
|
</para>
|
|
<para>
|
|
A <classname>Win32ServiceException</classname> is thrown on error.
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="changelog"><!-- {{{ -->
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>PECL win32service 1.0.0</entry>
|
|
<entry>
|
|
Throws a <classname>ValueError</classname> on invalid data in parameters,
|
|
previously &false; was returned.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>PECL win32service 1.0.0</entry>
|
|
<entry>
|
|
Throws a <classname>Win32ServiceException</classname> on error,
|
|
previously a
|
|
<link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Win32 Error Code</link>
|
|
was returned.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>PECL win32service 1.0.0</entry>
|
|
<entry>
|
|
The return type is now <type>void</type>, previously it was <type>mixed</type>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="seealso"><!-- {{{ -->
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>win32_start_service</function></member>
|
|
<member><function>win32_stop_service</function></member>
|
|
<member><function>win32_pause_service</function></member>
|
|
<member><function>win32_continue_service</function></member>
|
|
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|