php-doc-en/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml

72 lines
1.9 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-module-get-algo-key-size" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcrypt_module_get_algo_key_size</refname>
<refpurpose>Returns the maximum supported keysize of the opened mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcrypt_module_get_algo_key_size</methodname>
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
Gets the maximum supported keysize of the opened mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
The algorithm name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
This optional parameter can contain the location where the mode module
is on the system.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns the maximum supported key size of the
algorithm specified in bytes.
</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
-->