libssh2/share/man/man3/libssh2_sftp_close_handle.3

   1 .\" $Id: libssh2_sftp_close_handle.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_close_handle - close filehandle
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 int
  11 libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
  12
  13 int
  14 libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
  15
  16 int
  17 libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);
  18
  19 .SH DESCRIPTION
  20 \fIhandle\fP - SFTP File Handle as returned by
  21 .BR libssh2_sftp_open(3)
  22 or
  23 .BR libssh2_sftp_opendir(3)
  24
  25 Close an active LIBSSH2_SFTP_HANDLE. Because files and directories
  26 share the same underlying storage mechanism these methods may be used
  27 interchangably. It is recommended that
  28 .BR libssh2_sftp_close()
  29 be used for files and that
  30 .BR libssh2_sftp_closedir()
  31 be used for directories so that future changes in the library
  32 may cause minimal disruption.
  33
  34 .SH RETURN VALUE
  35 Return 0 on success or negative on failure.  It returns
  36 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  37 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  38
  39 .SH ERRORS
  40 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  41
  42 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  43
  44 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  45
  46 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  47 received on the socket, or an SFTP operation caused an errorcode to
  48 be returned by the server.
  49
  50 .SH SEE ALSO
  51 .BR libssh2_sftp_open(3)
  52 .BR libssh2_sftp_opendir(3)