mcrypt-get-block-size.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-get-block-size" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_get_block_size</refname>
  <refpurpose>Gets the block size of the specified cipher</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>mcrypt_get_block_size</methodname>
   <methodparam><type>int</type><parameter>cipher</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>mcrypt_get_block_size</methodname>
   <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</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_block_size</function> is used to get the
   size of a block of the specified <parameter>cipher</parameter> (in
   combination with an encryption mode).
  </para>
  <para>
   It is more useful to use the <function>mcrypt_enc_get_block_size</function>
   function as this uses the resource returned by
   <function>mcrypt_module_open</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>cipher</parameter></term>
     <listitem>
      &mcrypt.parameter.cipher;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      &mcrypt.parameter.mode;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the algorithm block size in bytes &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mcrypt_get_block_size</function> example</title>
    <para>
     This example shows how to use this function when linked against libmcrypt
     2.4.x and 2.5.x.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

echo mcrypt_get_block_size('tripledes', 'ecb'); // 8

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mcrypt_get_key_size</function></member>
    <member><function>mcrypt_enc_get_block_size</function></member>
    <member><function>mcrypt_encrypt</function></member>
   </simplelist>
  </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
-->