libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_sftp_rename_ex - rename an SFTP file
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
int
12
libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp,
13
                       const char *source_filename,
14
                       unsigned int source_filename_len,
15
                       const char *dest_filename,
16
                       unsigned int dest_filename_len,
17
                       long flags);
18

19
int
20
libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp,
21
                       const char *source_filename,
22
                       const char *dest_filename);
23
.fi
24
.SH DESCRIPTION
25
\fIsftp\fP - SFTP instance as returned by
26
.BR libssh2_sftp_init(3)
27

28
\fIsourcefile\fP - Path and name of the existing filesystem entry
29

30
\fIsourcefile_len\fP - Length of the path and name of the existing
31
filesystem entry
32

33
\fIdestfile\fP - Path and name of the target filesystem entry
34

35
\fIdestfile_len\fP - Length of the path and name of the target
36
filesystem entry
37

38
\fIflags\fP -
39
Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants.
40

41
Rename a filesystem object on the remote filesystem. The semantics of
42
this command typically include the ability to move a filesystem object
43
between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE
44
flag is not set and the destfile entry already exists, the operation
45
will fail. Use of the other two flags indicate a preference (but not a
46
requirement) for the remote end to perform an atomic rename operation
47
and/or using native system calls when possible.
48
.SH RETURN VALUE
49
Return 0 on success or negative on failure. It returns
50
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
51
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
52
.SH ERRORS
53
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
54

55
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
56

57
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
58

59
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
60
received on the socket, or an SFTP operation caused an errorcode to
61
be returned by the server.
62
.SH SEE ALSO
63
.BR libssh2_sftp_init(3)
64