libssh2_sftp_rmdir_ex - Man Page

remove an SFTP directory

Synopsis

#include <libssh2.h>
#include <libssh2_sftp.h>

int
libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path,
                      unsigned int path_len);

Description

Remove a directory from the remote file system.

sftp - SFTP instance as returned by libssh2_sftp_init(3)

sourcefile - Full path of the existing directory to remove.

sourcefile_len - Length of the full path of the existing directory to remove.

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

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

libssh2_sftp_init(3)

Referenced By

libssh2_sftp_rmdir(3).

1 Jun 2007 libssh2 0.15