b83c3e056e
Net::SSH2, the Perl wrapping module for libssh2 implements several features* on top of libssh2 that can fail and so need some mechanism to report the error condition to the user. Until now, besides the error state maintained internally by libssh2, another error state was maintained at the Perl level for every session object and then additional logic was used to merge both error states. That is a maintenance nighmare, and actually there is no way to do it correctly and consistently. In order to allow the high level language to add new features to the library but still rely in its error reporting features the new function libssh2_session_set_last_error (that just exposses _libssh2_error_flags) is introduced. *) For instance, connecting to a remote SSH service giving the hostname and port. Signed-off-by: Salvador Fandino <sfandino@yahoo.com> Signed-off-by: Salvador Fandiño <sfandino@yahoo.com>
33 lines
1.1 KiB
Groff
33 lines
1.1 KiB
Groff
.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_last_error - get the most recent error
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg, int *errmsg_len, int want_buf);
|
|
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fIerrmsg\fP - If not NULL, is populated by reference with the human
|
|
readable form of the most recent error message.
|
|
|
|
\fIerrmsg_len\fP - If not NULL, is populated by reference with the length
|
|
of errmsg. (The string is NUL-terminated, so the length is only useful as
|
|
an optimization, to avoid calling strlen.)
|
|
|
|
\fIwant_buf\fP - If set to a non-zero value, "ownership" of the errmsg
|
|
buffer will be given to the calling scope. If necessary, the errmsg buffer
|
|
will be duplicated.
|
|
|
|
Determine the most recent error condition and its cause.
|
|
|
|
.SH RETURN VALUE
|
|
Numeric error code corresponding to the the Error Code constants.
|
|
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_last_errno(3)
|
|
.BR libssh2_session_set_last_error(3)
|