php-doc-en/reference/mcrypt/functions/mcrypt-generic-end.xml
2016-01-08 01:35:03 +00:00

61 lines
1.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-generic-end" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcrypt_generic_end</refname>
<refpurpose>This function terminates encryption</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
&warn.deprecated.function.5-3-0.removed.7-0-0.alternatives;
<simplelist role="alternatives">
<member><function>mcrypt_generic_deinit</function></member>
</simplelist>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcrypt_generic_end</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<warning>
<para>
<function>mcrypt_generic_deinit</function> should be used instead of this
function, as it can cause crashes when used with
<function>mcrypt_module_close</function> due to multiple buffer frees.
</para>
</warning>
</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
success.
</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:"~/.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
-->