libssh2_sftp_rename_ex.3 (2173B)
1.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_sftp_rename_ex - rename an SFTP file 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7#include <libssh2_sftp.h> 8 9int 10libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, 11 const char *source_filename, 12 unsigned int source_filename_len, 13 const char *dest_filename, 14 unsigned int dest_filename_len, 15 long flags); 16 17int 18libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, 19 const char *source_filename, 20 const char *dest_filename); 21.fi 22.SH DESCRIPTION 23\fIsftp\fP - SFTP instance as returned by 24.BR libssh2_sftp_init(3) 25 26\fIsourcefile\fP - Path and name of the existing filesystem entry 27 28\fIsourcefile_len\fP - Length of the path and name of the existing 29filesystem entry 30 31\fIdestfile\fP - Path and name of the target filesystem entry 32 33\fIdestfile_len\fP - Length of the path and name of the target 34filesystem entry 35 36\fIflags\fP - 37Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants. 38 39Rename a filesystem object on the remote filesystem. The semantics of 40this command typically include the ability to move a filesystem object 41between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE 42flag is not set and the destfile entry already exists, the operation 43will fail. Use of the other two flags indicate a preference (but not a 44requirement) for the remote end to perform an atomic rename operation 45and/or using native system calls when possible. 46.SH RETURN VALUE 47Return 0 on success or negative on failure. It returns 48LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 49LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 50.SH ERRORS 51\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 52 53\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 54 55\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 56 57\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 58received on the socket, or an SFTP operation caused an errorcode to 59be returned by the server. 60.SH SEE ALSO 61.BR libssh2_sftp_init(3)