php-doc-en/reference/mcrypt/functions/mcrypt-get-key-size.xml
Derick Rethans fbb96c4203 - More mcrypt documentation adjustments
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@149073 c90b9560-bf6c-de11-be94-00142212c4b1
2004-01-17 21:39:10 +00:00

77 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.2 -->
<refentry id="function.mcrypt-get-key-size">
<refnamediv>
<refname>mcrypt_get_key_size</refname>
<refpurpose>Get the key size of the specified cipher</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mcrypt_get_key_size</methodname>
<methodparam><type>int</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>int</type><methodname>mcrypt_get_key_size</methodname>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
<methodparam><type>string</type><parameter>module</parameter></methodparam>
</methodsynopsis>
<para>
The first prototype is when linked against libmcrypt 2.2.x, the
second when linked against libmcrypt 2.4.x or 2.5.x.
</para>
<para>
<function>mcrypt_get_key_size</function> is used to get the size
of a key of the specified <parameter>cipher</parameter> (in
combination with an encryption mode).
</para>
<para>
This example shows how to use this function when linked against libmcrypt
2.4.x and 2.5.x. It is more useful to use the
<function>mcrypt_enc_get_key_size</function> function as this uses the
resource returned by <function>mcrypt_module_open</function>.
<example>
<title><function>mcrypt_get_block_size</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo mcrypt_get_key_size('tripledes', 'ecb');
?>
Prints:
24
]]>
</programlisting>
</example>
</para>
<para>
See also: <function>mcrypt_get_block_size</function>,
<function>mcrypt_end_get_key_size</function> and
<function>mcrypt_encrypt</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
-->