libssh2\_sftp\_posix\_rename\_ex(3) libssh2 libssh2\_sftp\_posix\_rename\_ex(3)

# [NAME](#NAME)

libssh2\_sftp\_posix\_rename\_ex - rename an SFTP file using POSIX semantics

# [SYNOPSIS](#SYNOPSIS)

```
#include <libssh2.h>
#include <libssh2_sftp.h>
int
libssh2_sftp_posix_rename_ex(LIBSSH2_SFTP *sftp,


                             const char *source_filename,


                             size_t source_filename_len,


                             const char *dest_filename,


                             size_t dest_filename_len);
```

# [DESCRIPTION](#DESCRIPTION)

*sftp* - SFTP instance as returned by [**libssh2\_sftp\_init(3)**](/man/os/libssh2/libssh2_sftp_init.3)

*sourcefile* - Path and name of the existing filesystem entry

*sourcefile\_len* - Length of the path and name of the existing filesystem entry

*destfile* - Path and name of the target filesystem entry

*destfile\_len* - Length of the path and name of the target filesystem entry

This function implements the posix-rename@openssh.com extension, which is useful when, for example, moving files across filesystems on a remote server. SSH\_FXP\_RENAME does not specify a specific implementation, but many servers will attempt to user hard links when moving files using SSH\_FXP\_RENAME.

If the server does not support posix-rename@openssh.com, this function will return LIBSSH2\_FX\_OP\_UNSUPPORTED and you can call [libssh2\_sftp\_rename\_ex (3)](/man/os/libssh2/libssh2_sftp_rename_ex.3) as a backup.

# [RETURN VALUE](#RETURN_VALUE)

Return 0 on success or negative on failure. It returns LIBSSH2\_ERROR\_EAGAIN when it would otherwise block. While LIBSSH2\_ERROR\_EAGAIN is a negative number, it is not really a failure per se.

# [ERRORS](#ERRORS)

*LIBSSH2\_FX\_OP\_UNSUPPORTED* - Server does not support posix-rename@openssh.com

*LIBSSH2\_ERROR\_ALLOC* - An internal memory allocation call failed.

*LIBSSH2\_ERROR\_SOCKET\_SEND* - Unable to send data on socket.

*LIBSSH2\_ERROR\_SOCKET\_TIMEOUT* -

*LIBSSH2\_ERROR\_SFTP\_PROTOCOL* - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server.

# [SEE ALSO](#SEE_ALSO)

[**libssh2\_sftp\_init(3)**](/man/os/libssh2/libssh2_sftp_init.3)

9 May 2024 libssh2 1.11.1

---

Document: libssh2_sftp_posix_rename_ex(3) from libssh2 1.11.1-r11 (Chainguard OS)
Source: https://github.com/libssh2/libssh2.git
