libssh2_session_free man page

libssh2_session_free — frees resources associated with a session instance

Synopsis

#include <libssh2.h>

int libssh2_session_free(LIBSSH2_SESSION *session);

Description

Frees all resources associated with a session instance. Typically called after libssh2_session_disconnect_ex(3)

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_session_disconnect_ex(3)

Referenced By

libssh2_session_banner_get(3), libssh2_session_handshake(3), libssh2_session_init_ex(3), libssh2_session_startup(3).

1 Jun 2007 libssh2 0.15 libssh2 manual