1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Add a new function `libssh2_sftp_posix_rename_ex()` and
`libssh2_sftp_posix_rename()`, which implement
the posix-rename@openssh.com extension.

If the server does not support this extension, the function returns
`LIBSSH2_FX_OP_UNSUPPORTED` and it's up to the user to recover, possibly
by calling `libssh2_sftp_rename()`.

Co-authored-by: Viktor Szakats (bump to size_t)
Closes #1386
This commit is contained in:
Michael Buckley
2024-05-09 15:39:28 -07:00
committed by Viktor Szakats
parent dc206408c1
commit fb6527468c
6 changed files with 254 additions and 3 deletions

View File

@ -0,0 +1,24 @@
.\" Copyright (C) The libssh2 project and its contributors.
.\" SPDX-License-Identifier: BSD-3-Clause
.TH libssh2_sftp_posix_rename 3 "9 May 2024" "libssh2 1.11.1" "libssh2"
.SH NAME
libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_posix_rename_ex(3)\fP calls
.SH SYNOPSIS
.nf
#include <libssh2.h>
#include <libssh2_sftp.h>
int
libssh2_sftp_posix_rename(LIBSSH2_SFTP *sftp,
const char *source_filename,
const char *destination_filename);
.fi
.SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_sftp_posix_rename_ex(3)\fP.
.SH RETURN VALUE
See \fIlibssh2_sftp_posix_rename_ex(3)\fP
.SH ERRORS
See \fIlibssh2_sftp_posix_rename_ex(3)\fP
.SH SEE ALSO
.BR libssh2_sftp_posix_rename_ex(3)