libssh2_sftp_shutdown.3 667 B

123456789101112131415161718192021222324
  1. .TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
  2. .SH NAME
  3. libssh2_sftp_shutdown - shut down an SFTP session
  4. .SH SYNOPSIS
  5. #include <libssh2.h>
  6. #include <libssh2_sftp.h>
  7. int
  8. libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);
  9. .SH DESCRIPTION
  10. \fIsftp\fP - SFTP instance as returned by
  11. .BR libssh2_sftp_init(3)
  12. Destroys a previously initialized SFTP session and frees all resources
  13. associated with it.
  14. .SH RETURN VALUE
  15. Return 0 on success or negative on failure. It returns
  16. LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  17. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  18. .SH SEE ALSO
  19. .BR libssh2_sftp_init(3)