win32-set-service-exit-mode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 05568582247276cc2ee7b2b87f7df7d602e566c0 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes Maintainer: Marqitos -->

<refentry xml:id="function.win32-set-service-exit-mode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>win32_set_service_exit_mode</refname>
  <refpurpose>Define o devuelve el modo de salida para el servicio en ejecución</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis role="procedural">
   <type>bool</type><methodname>win32_set_service_exit_mode</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>gracefulMode</parameter><initializer>true</initializer></methodparam>
  </methodsynopsis>
  <para>
   Si se proporciona el argumento <parameter>gracefulMode</parameter>, se modifica el modo de
   salida. Cuando el modo de salida no es correcto, el código de salida utilizado puede ser definido con la función
   <function>win32_set_service_exit_code</function>.
  </para>

  <caution>
   <para>
    Esta función solo funciona en el SAPI "cli". En otros SAPI, esta
    función está deshabilitada.
   </para>
  </caution>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>gracefulMode</parameter></term>
    <listitem>
     <para>
      &true; para la salida correcta. &false; para la salida con error.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Devuelve el modo de salida actual o anterior.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI <literal>"cli"</literal>, se emitirá
   un error <constant>E_ERROR</constant>.
  </para>
  <para>
   A partir de la versión 1.0.0, lanzará una
   <classname>Win32ServiceException</classname> si el SAPI no es
   <literal>"cli"</literal>
  </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>
        Lanzará una <classname>ValueError</classname> si un argumento es inválido,
        antes &false; era retornado.
       </entry>
      </row>
      <row>
       <entry>PECL win32service 1.0.0</entry>
       <entry>
        Lanzará una <classname>Win32ServiceException</classname> en caso de error,
        antes un
        <link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Código de error Win32</link>
        era retornado.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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_code</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
-->