mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-04-03 09:48:55 +00:00
91 lines
2.6 KiB
XML
91 lines
2.6 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<!-- $Revision$ -->
|
||
|
|
|
||
|
|
<refentry xml:id="function.win32-set-service-exit-code" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>win32_set_service_exit_code</refname>
|
||
|
|
<refpurpose>Define or return the exit code for the current running service</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
|
||
|
|
<refsect1 role="description"><!-- {{{ -->
|
||
|
|
&reftitle.description;
|
||
|
|
<methodsynopsis role="procedural">
|
||
|
|
<type>int</type><methodname>win32_set_service_exit_code</methodname>
|
||
|
|
<methodparam choice="opt"><type>int</type><parameter>exitCode</parameter><initializer>1</initializer></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
Change or return the exit code. The exit code is used only if the exit mode is not graceful.
|
||
|
|
If the value is not zero, the recovery configuration can be used after
|
||
|
|
service fail. See
|
||
|
|
<link xlink:href="&url.microsoft.return.code;">Microsoft system error codes</link>
|
||
|
|
for more details
|
||
|
|
</para>
|
||
|
|
|
||
|
|
<caution>
|
||
|
|
<para>
|
||
|
|
This function work only in "cli" SAPI. On other SAPI
|
||
|
|
this function is disabled.
|
||
|
|
</para>
|
||
|
|
</caution>
|
||
|
|
</refsect1><!-- }}} -->
|
||
|
|
|
||
|
|
<refsect1 role="parameters"><!-- {{{ -->
|
||
|
|
&reftitle.parameters;
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>exitCode</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The return code used on exit.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1><!-- }}} -->
|
||
|
|
|
||
|
|
<refsect1 role="returnvalues"><!-- {{{ -->
|
||
|
|
&reftitle.returnvalues;
|
||
|
|
<para>
|
||
|
|
Return the current or old exit code.
|
||
|
|
</para>
|
||
|
|
</refsect1><!-- }}} -->
|
||
|
|
|
||
|
|
<refsect1 role="errors"><!-- {{{ -->
|
||
|
|
&reftitle.errors;
|
||
|
|
<para>
|
||
|
|
If SAPI is not <literal>"cli"</literal>, this function emits an
|
||
|
|
<constant>E_ERROR</constant> level error.
|
||
|
|
</para>
|
||
|
|
</refsect1><!-- }}} -->
|
||
|
|
|
||
|
|
<refsect1 role="seealso"><!-- {{{ -->
|
||
|
|
&reftitle.seealso;
|
||
|
|
<simplelist>
|
||
|
|
<member><function>win32_start_service_ctrl_dispatcher</function></member>
|
||
|
|
<member><function>win32_set_service_status</function></member>
|
||
|
|
<member><function>win32_set_service_exit_mode</function></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
|
||
|
|
-->
|