libssh2/share/man/man3/libssh2_sftp_rmdir_ex.3

   1 .\" $Id: libssh2_sftp_rmdir_ex.3,v 1.1 2007/06/14 16:08:43 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_rmdir_ex - rename a file
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 int
  11 libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len);
  12
  13 int
  14 libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path);
  15
  16 .SH DESCRIPTION
  17 \fIsftp\fP - SFTP instance as returned by
  18 .BR libssh2_sftp_init(3)
  19
  20 \fIsourcefile\fP - Full path of the existing directory to remove.
  21
  22 \fIsourcefile_len\fP - Length of the full path of the existing directory to remove.
  23
  24 Remove a directory from the remote file system.
  25
  26 .SH RETURN VALUE
  27 Return 0 on success or negative on failure.  It returns
  28 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  29 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  30
  31 .SH ERRORS
  32 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  33
  34 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  35
  36 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  37
  38 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  39 received on the socket, or an SFTP operation caused an errorcode to
  40 be returned by the server.
  41
  42 .SH SEE ALSO
  43 .BR libssh2_sftp_init(3)