libssh2_session_free.3 664 B

123456789101112131415161718
  1. .TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
  2. .SH NAME
  3. libssh2_session_free - frees resources associated with a session instance
  4. .SH SYNOPSIS
  5. #include <libssh2.h>
  6. int
  7. libssh2_session_free(LIBSSH2_SESSION *session);
  8. .SH DESCRIPTION
  9. Frees all resources associated with a session instance. Typically called after
  10. .BR libssh2_session_disconnect_ex(3)
  11. .SH RETURN VALUE
  12. Return 0 on success or negative on failure. It returns
  13. LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  14. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  15. .SH SEE ALSO
  16. .BR libssh2_session_init_ex(3)
  17. .BR libssh2_session_disconnect_ex(3)