RT3462: Document actions when data==NULL
authorRich Salz <rsalz@openssl.org>
Mon, 8 Sep 2014 15:48:34 +0000 (11:48 -0400)
committerRich Salz <rsalz@openssl.org>
Fri, 3 Oct 2014 14:39:00 +0000 (10:39 -0400)
If data is NULL, return the size needed to hold the
derived key.  No other API to do this, so document
the behavior.

Reviewed-by: Richard Levitte <levitte@openssl.org>
doc/crypto/EVP_BytesToKey.pod

index d07ae6c7b514a92f9d2c85aa0500cc742c3f7efb..cd3aa027ee929e59a4a25b9107e41d0cb9c7ea9e 100644 (file)
@@ -55,7 +55,10 @@ the IV.
 
 =head1 RETURN VALUES
 
-EVP_BytesToKey() returns the size of the derived key in bytes, or 0 on error.
+If B<data> is NULL, then EVP_BytesToKey() returns the number of bytes
+needed to store the derived key.
+Otherwise, EVP_BytesToKey() returns the size of the derived key in bytes,
+or 0 on error.
 
 =head1 SEE ALSO