libssh2_session_set_last_error - sets the internal error state
#include <libssh2.h> int libssh2_session_set_last_error(LIBSSH2_SESSION *session, int errcode, const char *errmsg)
libssh2 manual libssh2_session_set_last_error(3ssh2)
NAME
libssh2_session_set_last_error - sets the internal error state
SYNOPSIS
#include <libssh2.h>
int libssh2_session_set_last_error(LIBSSH2_SESSION *session, int
errcode, const char *errmsg)
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
errcode - One of the error codes as defined in the public libssh2
header file.
errmsg - 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.
RETURN VALUE
Numeric error code corresponding to the the Error Code constants.
AVAILABILITY
Added in 1.6.1
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_session_last_error(3) libssh2_session_last_errno(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 1.6.1 26 Oct 2015