libssh2

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

11
int
12
libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path,
13
                      unsigned int path_len);
14
.fi
15
.SH DESCRIPTION
16
Remove a directory from the remote file system.
17

18
\fIsftp\fP - SFTP instance as returned by
19
.BR libssh2_sftp_init(3)
20

21
\fIsourcefile\fP - Full path of the existing directory to remove.
22

23
\fIsourcefile_len\fP - Length of the full path of the existing directory to
24
remove.
25
.SH RETURN VALUE
26
Return 0 on success or negative on failure. It returns
27
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
28
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
29
.SH ERRORS
30
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
31

32
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
33

34
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
35

36
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
37
received on the socket, or an SFTP operation caused an errorcode to
38
be returned by the server.
39
.SH SEE ALSO
40
.BR libssh2_sftp_init(3)
41