php-doc-en/reference/mcrypt/functions/mcrypt-generic-deinit.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.27 -->
  <refentry id='function.mcrypt-generic-deinit'>
   <refnamediv>
    <refname>mcrypt_generic_deinit</refname>
    <refpurpose>
     This function deinitializes an encryption module
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>mcrypt_generic_deinit</methodname>
      <methodparam><type>resource</type><parameter>td</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function terminates encryption specified by the encryption
     descriptor (<parameter>td</parameter>). It clears all buffers, but does
     not close the module.  You need to call
     <function>mcrypt_module_close</function> yourself. (But PHP does this for
     you at the end of the script.  Returns &false; on error, or &true; on
     succes.
    </para>
    <para>
     See for an example <function>mcrypt_module_open</function> and the
     entry on <function>mcrypt_generic_init</function>.
    </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
-->