shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-09 18:04:25 +09:00
Code Issues Packages Projects Releases Wiki Activity

Improve and document ssh_set_error().

Browse Source 
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@719 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
Andreas Schneider
2009-05-05 07:25:07 +00:00
parent 8c45767d34
commit 4838742a8e
1 changed files with 23 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
libssh/error.c
View File

@@ -27,22 +27,35 @@
#include <stdarg.h> #include <stdarg.h>
#include "libssh/priv.h" #include "libssh/priv.h"
/** \defgroup ssh_error SSH Errors /**
* \brief error handling * @defgroup ssh_error SSH Errors
*
* @brief Functions for error handling.
*/ */
/** \addtogroup ssh_error /**
* @addtogroup ssh_error
* @{ * @{
*/ */
/* ssh_set_error registers an error with a description. the error code is the class of error, and description is obvious.*/ /**
* @brief Registers an error with a description.
*
* @param error The class of error.
*
* @param code The class of error.
*
* @param descr The description, which can be a format string.
*
* @param ... The arguments for the format string.
*/
void ssh_set_error(void *error, int code, const char *descr, ...) { void ssh_set_error(void *error, int code, const char *descr, ...) {
struct error_struct *err= error; struct error_struct *err = error;
va_list va; va_list va;
va_start(va,descr); va_start(va, descr);
vsnprintf(err->error_buffer,ERROR_BUFFERLEN,descr,va); vsnprintf(err->error_buffer, ERROR_BUFFERLEN, descr, va);
va_end(va); va_end(va);
err->error_code=code; err->error_code = code;
} }
/** \brief retrieve an error text message /** \brief retrieve an error text message