1libssh2_sftp_unlink_ex(3)       libssh2 manual       libssh2_sftp_unlink_ex(3)
2
3
4

NAME

6       libssh2_sftp_unlink_ex - rename a file
7

SYNOPSIS

9       #include <libssh2.h> #include <libssh2_sftp.h>
10
11       int  libssh2_sftp_unlink_ex(LIBSSH2_SFTP  *sftp,  const char *filename,
12       unsigned int filename_len);
13
14       int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename);
15
16

DESCRIPTION

18       sftp - SFTP instance as returned by libssh2_sftp_init(3)
19
20       filename - Path and name of the existing filesystem entry
21
22       filename_len - Length of the path and name of the  existing  filesystem
23       entry
24
25       Unlink (delete) a file from the remote filesystem.
26
27

RETURN VALUE

29       Return   0  on  success  or  negative  on  failure.   It  returns  LIB‐
30       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB‐
31       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
32       se.
33
34

ERRORS

36       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.
37
38       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
39
40       LIBSSH2_ERROR_SOCKET_TIMEOUT -
41
42       LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid  SFTP  protocol  response  was
43       received  on the socket, or an SFTP operation caused an errorcode to be
44       returned by the server.
45
46

SEE ALSO

48       libssh2_sftp_init(3)
49
50
51
52libssh2 0.15                      1 Jun 2007         libssh2_sftp_unlink_ex(3)