2002-04-15 00:12:54 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2002-04-17 06:45:35 +00:00
|
|
|
<!-- $Revision: 1.2 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
|
|
|
|
|
<refentry id="function.mcrypt-get-iv-size">
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>mcrypt_get_iv_size</refname>
|
|
|
|
|
<refpurpose>Returns the size of the IV belonging to a specific cipher/mode combination</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>int</type><methodname>mcrypt_get_iv_size</methodname>
|
|
|
|
|
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
|
|
|
|
|
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
|
|
|
|
|
</methodsynopsis>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>int</type><methodname>mcrypt_get_iv_size</methodname>
|
|
|
|
|
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
|
|
|
|
|
</methodsynopsis>
|
|
|
|
|
<para>
|
|
|
|
|
The first prototype is when linked against libmcrypt 2.2.x, the
|
|
|
|
|
second when linked against libmcrypt 2.4.x.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<function>mcrypt_get_iv_size</function> returns the size of
|
|
|
|
|
the Initialisation Vector (IV) in bytes. On error the function
|
|
|
|
|
returns &false;. If the IV is ignored in the specified cipher/mode
|
|
|
|
|
combination zero is returned.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<parameter>Cipher</parameter> is one of the MCRYPT_ciphername
|
|
|
|
|
constants of the name of the algorithm as string.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<parameter>Mode</parameter> is one of the MCRYPT_MODE_modename
|
|
|
|
|
constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or
|
|
|
|
|
"stream".
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<parameter>Td</parameter> is the algorithm specified.
|
|
|
|
|
</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
|
|
|
|
|
-->
|
