[PHP-DOC] cvs: phpdoc /en/functions mcrypt.xml From: Ron Chmara (ron <email protected>)
Date: 09/30/00

ronabop Sat Sep 30 10:11:38 2000 EDT

  Modified files:
    /phpdoc/en/functions mcrypt.xml
  Log:
  Updated funcproto's for 2.4.
  
Index: phpdoc/en/functions/mcrypt.xml
diff -u phpdoc/en/functions/mcrypt.xml:1.9 phpdoc/en/functions/mcrypt.xml:1.10
--- phpdoc/en/functions/mcrypt.xml:1.9 Fri Sep 15 10:48:37 2000
+++ phpdoc/en/functions/mcrypt.xml Sat Sep 30 10:11:38 2000
@@ -419,14 +419,24 @@
       <funcdef>int <function>mcrypt_get_block_size</function></funcdef>
       <paramdef>int <parameter>cipher</parameter></paramdef>
      </funcprototype>
+ <funcprototype>
+ <funcdef>int <function>mcrypt_get_block_size</function></funcdef>
+ <paramdef>string <parameter>cipher</parameter></paramdef>
+ <paramdef>string <parameter>module</parameter></paramdef>
+ </funcprototype>
     </funcsynopsis>
     <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_block_size</function> is used to get the
      size of a block of the specified <parameter>cipher</parameter>.
     </para>
     <para>
- <function>Mcrypt_get_block_size</function> takes one argument, the
- <parameter>cipher</parameter> and returns the size in bytes.
+ <function>Mcrypt_get_block_size</function> takes one or two
+ arguments, the <parameter>cipher</parameter> and
+ <parameter>module</parameter>, and returns the size in bytes.
     </para>
     <para>
      See also: <function>mcrypt_get_key_size</function>.
@@ -446,14 +456,24 @@
       <funcdef>int <function>mcrypt_get_key_size</function></funcdef>
       <paramdef>int <parameter>cipher</parameter></paramdef>
      </funcprototype>
+ <funcprototype>
+ <funcdef>int <function>mcrypt_get_key_size</function></funcdef>
+ <paramdef>string <parameter>cipher</parameter></paramdef>
+ <paramdef>string <parameter>module</parameter></paramdef>
+ </funcprototype>
     </funcsynopsis>
     <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_key_size</function> is used to get the size
      of a key of the specified <parameter>cipher</parameter>.
     </para>
     <para>
- <function>mcrypt_get_key_size</function> takes one argument, the
- <parameter>cipher</parameter> and returns the size in bytes.
+ <function>Mcrypt_get_key_size</function> takes one or two
+ arguments, the <parameter>cipher</parameter> and
+ <parameter>module</parameter>, and returns the size in bytes.
     </para>
     <para>
      See also: <function>mcrypt_get_block_size</function>.
@@ -879,11 +899,19 @@
       <paramdef>string <parameter>cipher</parameter></paramdef>
       <paramdef>string <parameter>mode</parameter></paramdef>
      </funcprototype>
+ <funcprototype>
+ <funcdef>int <function>mcrypt_get_iv_size</function></funcdef>
+ <paramdef>resource <parameter>td</parameter></paramdef>
+ </funcprototype>
     </funcsynopsis>
     <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). On error the function returns
- FALSE. If the IV is ignored in the specified cipher/mode
+ 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>
@@ -894,6 +922,9 @@
      <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>