libssh2/share/man/man3/libssh2_sftp_shutdown.3

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