libssh2_hostkey_hash.3: update the description of return value

The function returns NULL also if the hash algorithm is not available.
This commit is contained in:
Kamil Dudka 2012-11-01 14:57:06 +01:00
parent d49b8f303a
commit fe8f3deb48

View File

@ -18,8 +18,9 @@ Returns the computed digest of the remote system's hostkey. The length of
the returned string is hash_type specific (e.g. 16 bytes for MD5, the returned string is hash_type specific (e.g. 16 bytes for MD5,
20 bytes for SHA1). 20 bytes for SHA1).
.SH RETURN VALUE .SH RETURN VALUE
Computed hostkey hash value. or NULL if the session has not yet been started Computed hostkey hash value, or NULL if the information is not available
up. (The hash consists of raw binary bytes, not hex digits, so is not (either the session has not yet been started up, or the requested hash
directly printable.) algorithm was not available). The hash consists of raw binary bytes, not hex
digits, so it is not directly printable.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)