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>
34 lines
985 B
Groff
34 lines
985 B
Groff
.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2 1.6.1" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_set_last_error - sets the internal error state
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_session_set_last_error(LIBSSH2_SESSION *session, int errcode, const char *errmsg)
|
|
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fIerrcode\fP - One of the error codes as defined in the public
|
|
libssh2 header file.
|
|
|
|
\fIerrmsg\fP - If not NULL, a copy of the given string is stored
|
|
inside the session object as the error message.
|
|
|
|
This function is provided for high level language wrappers
|
|
(i.e. Python or Perl) and other libraries that may extend libssh2 with
|
|
additional features while still relying on its error reporting
|
|
mechanism.
|
|
|
|
.SH RETURN VALUE
|
|
Numeric error code corresponding to the the Error Code constants.
|
|
|
|
.SH AVAILABILITY
|
|
Added in 1.6.1
|
|
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_last_error(3)
|
|
.BR libssh2_session_last_errno(3)
|