libssh2/share/man/man3/libssh2_sftp_unlink_ex.3

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