Format ssh_get_error().

git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@721 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
Andreas Schneider
2009-05-05 07:27:16 +00:00
parent 8af13665ab
commit 53a24a4f78

View File

@@ -60,13 +60,17 @@ void ssh_set_error(void *error, int code, const char *descr, ...) {
err->error_code = code; err->error_code = code;
} }
/** \brief retrieve an error text message /**
* \param error the ssh session pointer * @brief Retrieve an error text message.
* \return a static string describing the error *
* @param error The ssh session pointer.
*
* @return A static string describing the error.
*/ */
const char *ssh_get_error(void *error){ const char *ssh_get_error(void *error) {
struct error_struct *err=error; struct error_struct *err = error;
return err->error_buffer;
return err->error_buffer;
} }
/** \brief retrieve the error code from the last /** \brief retrieve the error code from the last