libssh2_session_set_last_error.3 (1007B)
1.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2" "libssh2" 2.SH NAME 3libssh2_session_set_last_error - sets the internal error state 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_set_last_error(LIBSSH2_SESSION *session, 10 int errcode, const char *errmsg) 11.fi 12.SH DESCRIPTION 13\fIsession\fP - Session instance as returned by 14.BR libssh2_session_init_ex(3) 15 16\fIerrcode\fP - One of the error codes as defined in the public 17libssh2 header file. 18 19\fIerrmsg\fP - If not NULL, a copy of the given string is stored 20inside the session object as the error message. 21 22This function is provided for high level language wrappers 23(i.e. Python or Perl) and other libraries that may extend libssh2 with 24additional features while still relying on its error reporting 25mechanism. 26.SH RETURN VALUE 27Numeric error code corresponding to the the Error Code constants. 28.SH AVAILABILITY 29Added in 1.6.1 30.SH SEE ALSO 31.BR libssh2_session_last_error(3) 32.BR libssh2_session_last_errno(3)