cvs: phpdoc /en/reference/mcrypt/functions mcrypt-generic-init.xml

derick Fri Apr 25 14:52:33 2003 EDT Modified files: /phpdoc/en/reference/mcrypt/functions mcrypt-generic-init.xml Log: - Clarification of the return code Index: phpdoc/en/reference/mcrypt/functions/mcrypt-generic-init.xml diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-generic-init.xml:1.3 phpdoc/en/reference/mcrypt/functions/mcrypt-generic-init.xml:1.4 --- phpdoc/en/reference/mcrypt/functions/mcrypt-generic-init.xml:1.3 Sun May 12 17:00:19 2002 +++ phpdoc/en/reference/mcrypt/functions/mcrypt-generic-init.xml Fri Apr 25 14:52:33 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 --> <refentry id="function.mcrypt-generic-init"> <refnamediv> @@ -24,7 +24,13 @@ and OFB modes. It needs to be random and unique (but not secret). The same IV must be used for encryption/decryption. If you do not want to use it you should set it to zeros, but this is not - recommended. The function returns a negative value on error. + recommended. + </para> + <para> + The function returns a negative value on error, -3 when the key length + was incorrect, -4 when there was a memory allocation problem and any + other return value is an unknown error. If an error occurs a warning will + be displayed accordingly. </para> <para> You need to call this function before every call to