diff options
author | Simon Josefsson <simon@josefsson.org> | 2009-05-27 07:38:04 +0200 |
---|---|---|
committer | Simon Josefsson <simon@josefsson.org> | 2009-05-27 07:38:04 +0200 |
commit | 8f4c475ce3e865a1352369a0f1344fbef422f036 (patch) | |
tree | 0cf92575c36735d45ec1c85c626365c6246ccdc2 | |
parent | d8cac9034d31a6b41bb5f310e0aa2d9c599a597c (diff) | |
download | gnutls-8f4c475ce3e865a1352369a0f1344fbef422f036.tar.gz |
Doc fix.
Reported by Peter Hendrickson <pdh@wiredyne.com>.
-rw-r--r-- | lib/gnutls_ui.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c index bd30a7e698..cedf1a0d47 100644 --- a/lib/gnutls_ui.c +++ b/lib/gnutls_ui.c @@ -295,10 +295,13 @@ gnutls_dh_get_secret_bits (gnutls_session_t session) * * This function will return the bits of the prime used in the last * Diffie-Hellman authentication with the peer. Should be used for - * both anonymous and ephemeral Diffie-Hellman. + * both anonymous and ephemeral Diffie-Hellman. Note that some + * ciphers, like RSA and DSA without DHE, does not use a + * Diffie-Hellman exchange, and then this function will return 0. * - * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise - * an error code is returned. + * Returns: The Diffie-Hellman bit strength is returned, or 0 if no + * Diffie-Hellman exchange was done, or a negative error code on + * failure. **/ int gnutls_dh_get_prime_bits (gnutls_session_t session) |