diff options
Diffstat (limited to 'libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3')
-rw-r--r-- | libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 new file mode 100644 index 0000000..42cc1c4 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 @@ -0,0 +1,24 @@ +.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_shutdown - shut down an SFTP session +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Destroys a previously initialized SFTP session and frees all resources +associated with it. + +.SH 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. + +.SH SEE ALSO +.BR libssh2_sftp_init(3) |