bionic (3) libssh2_sftp_rmdir_ex.3.gz

Provided by: libssh2-1-dev_1.8.0-1ubuntu0.1_amd64 bug

NAME

       libssh2_sftp_rmdir_ex - 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 isn't 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)