mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
33 lines
1007 B
Groff
33 lines
1007 B
Groff
.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_session_set_last_error - sets the internal error state
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_session_set_last_error(LIBSSH2_SESSION *session,
|
|
int errcode, const char *errmsg)
|
|
.fi
|
|
.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)
|