Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_session_last_error (3ssh2)

Name

libssh2_session_last_error - get the most recent error

Synopsis

#include <libssh2.h>

int libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg,
int *errmsg_len, int want_buf);

Description

libssh2 manual                               libssh2_session_last_error(3ssh2)



NAME
       libssh2_session_last_error - get the most recent error

SYNOPSIS
       #include <libssh2.h>

       int libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg,
       int *errmsg_len, int want_buf);


DESCRIPTION
       session - Session instance as returned by libssh2_session_init_ex(3)

       errmsg - If not NULL, is populated by reference with the human readable
       form of the most recent error message.

       errmsg_len  - If not NULL, is populated by reference with the length of
       errmsg. (The string is NUL-terminated, so the length is only useful  as
       an optimization, to avoid calling strlen.)

       want_buf - If set to a non-zero value, "ownership" of the errmsg buffer
       will be given to the calling scope. If  necessary,  the  errmsg  buffer
       will be duplicated.

       Determine the most recent error condition and its cause.


RETURN VALUE
       Numeric error code corresponding to the the Error Code constants.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_session_last_errno(3) libssh2_session_set_last_error(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 0.15                      1 Jun 2007
                                             libssh2_session_last_error(3ssh2)