lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-12-02 01:17:52 +03:00
Code Activity

doc: Fix description of error parameter for ssh_get_error*

Browse Source 
ssh_get_error can actually work on anything with an ssh_common_struct
as its first member.  It is already used in examples in the
distribution with ssh_sessions and ssh_binds.

Signed-off-by: Alan Dunn <amdunn@gmail.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Alan Dunn
2014-01-21 13:29:29 -06:00
committed by Andreas Schneider
parent 465816f4a0
commit 7eff889384
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/error.c
View File

@@ -104,7 +104,7 @@ void _ssh_set_error_invalid(void *error, const char *function)
/** /**
* @brief Retrieve the error text message from the last error. * @brief Retrieve the error text message from the last error.
* *
* @param error The SSH session pointer. * @param error An ssh_session or ssh_bind.
* *
* @return A static string describing the error. * @return A static string describing the error.
*/ */
@@ -117,7 +117,7 @@ const char *ssh_get_error(void *error) {
/** /**
* @brief Retrieve the error code from the last error. * @brief Retrieve the error code from the last error.
* *
* @param error The SSH session pointer. * @param error An ssh_session or ssh_bind.
* *
* \return SSH_NO_ERROR No error occurred\n * \return SSH_NO_ERROR No error occurred\n
* SSH_REQUEST_DENIED The last request was denied but situation is * SSH_REQUEST_DENIED The last request was denied but situation is