php-doc-en/reference/mcrypt/functions/mcrypt-generic-end.xml
Derick Rethans baf0dab17e - Overhaul of the mcrypt docs, including new examples, corrected entries and
newly documented functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@82020 c90b9560-bf6c-de11-be94-00142212c4b1
2002-05-12 21:00:20 +00:00

49 lines
1.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
<refentry id="function.mcrypt-generic-end">
<refnamediv>
<refname>mcrypt_generic_end</refname>
<refpurpose>This function terminates encryption</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mcrypt_generic_end</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecated, use
<function>mcrypt_generic_deinit</function> instead. It can cause crashes
when used with <function>mcrypt_module_close</function> due to multiple
buffer frees.
</para>
<para>
This function terminates encryption specified by the encryption
descriptor (<parameter>td</parameter>). Actually it clears all buffers,
and closes all the modules used. Returns &false; on error, or &true; on
succes.
</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
-->