libssh2_session_last_error.3 (1107B)
1.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_session_last_error - get the most recent error 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_last_error(LIBSSH2_SESSION *session, 10 char **errmsg, int *errmsg_len, int want_buf); 11.fi 12.SH DESCRIPTION 13\fIsession\fP - Session instance as returned by 14.BR libssh2_session_init_ex(3) 15 16\fIerrmsg\fP - If not NULL, is populated by reference with the human 17readable form of the most recent error message. 18 19\fIerrmsg_len\fP - If not NULL, is populated by reference with the length 20of errmsg. (The string is NUL-terminated, so the length is only useful as 21an optimization, to avoid calling strlen.) 22 23\fIwant_buf\fP - If set to a non-zero value, "ownership" of the errmsg 24buffer will be given to the calling scope. If necessary, the errmsg buffer 25will be duplicated. 26 27Determine the most recent error condition and its cause. 28.SH RETURN VALUE 29Numeric error code corresponding to the the Error Code constants. 30.SH SEE ALSO 31.BR libssh2_session_last_errno(3) 32.BR libssh2_session_set_last_error(3)