libssh2_session_last_error(3) [debian man page]

libssh2_session_last_error(3)					  libssh2 manual				     libssh2_session_last_error(3)

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.

SEE ALSO

       libssh2_session_last_errno(3)

libssh2 0.15							    1 Jun 2007					     libssh2_session_last_error(3)

libssh2_session_disconnect_ex(3)				  libssh2 manual				  libssh2_session_disconnect_ex(3)

NAME

       libssh2_session_disconnect_ex - terminate transport layer

SYNOPSIS

       #include <libssh2.h>

       int libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang);

       int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);

DESCRIPTION

       session - Session instance as returned by libssh2_session_init_ex(3)

       reason - One of the Disconnect Reason constants.

       description - Human readable reason for disconnection.

       lang - Localization string describing the langauge/encoding of the description provided.

       Send a disconnect message to the remote host associated with session, along with a reason symbol and a verbose description.

       As  a  convenience,  the  macro	libssh2_session_disconnect(3)  is  provided.  It calls libssh2_session_disconnect_ex(3) with reason set to
       SSH_DISCONNECT_BY_APPLICATION and lang set to an empty string.

RETURN VALUE

       Return 0 on success or negative on failure.  It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a
       negative number, it isn't really a failure per se.

SEE ALSO

       libssh2_session_init_ex(3)

libssh2 0.15							    1 Jun 2007					  libssh2_session_disconnect_ex(3)