<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
  <refentry id="function.mcrypt-list-modes">
   <refnamediv>
    <refname>mcrypt_list_modes</refname>
    <refpurpose>Get an array of all supported modes</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>mcrypt_list_modes</methodname>
      <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>mcrypt_list_modes</function> is used to get an
     array of all supported modes in the
     <parameter>lib_dir</parameter>.
    </para>
    <para>
     <function>mcrypt_list_modes</function> takes as optional
     parameter a directory which specifies the directory where all
     modes are located. If not specifies, the value of the
     mcrypt.modes_dir &php.ini; directive is used.
    </para>
    <para>
     <example>
      <title><function>mcrypt_list_modes</function> Example</title>
      <programlisting role="php">
<![CDATA[
<?php
    $modes = mcrypt_list_modes();

    foreach ($modes as $mode) {
        echo "$mode <br />\n";
    }
?>
]]>
      </programlisting>
      <para>
       The above example will produce a list with all supported
       algorithms in the default mode directory. If it is not set
       with the ini directive mcrypt.modes_dir, the default directory
       of mcrypt is used (which is /usr/local/lib/libmcrypt).
      </para>
     </example>
    </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
-->