mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-19 02:24:04 +03:00
fb6527468c
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
25 lines
816 B
Groff
25 lines
816 B
Groff
.\" 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)
|