libssh2_sftp_rmdir_ex.3 (1191B)
1.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_sftp_rmdir_ex - remove an SFTP directory 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7#include <libssh2_sftp.h> 8 9int 10libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, 11 unsigned int path_len); 12.fi 13.SH DESCRIPTION 14Remove a directory from the remote file system. 15 16\fIsftp\fP - SFTP instance as returned by 17.BR libssh2_sftp_init(3) 18 19\fIsourcefile\fP - Full path of the existing directory to remove. 20 21\fIsourcefile_len\fP - Length of the full path of the existing directory to 22remove. 23.SH RETURN VALUE 24Return 0 on success or negative on failure. It returns 25LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 26LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 27.SH ERRORS 28\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 29 30\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 31 32\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 33 34\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 35received on the socket, or an SFTP operation caused an errorcode to 36be returned by the server. 37.SH SEE ALSO 38.BR libssh2_sftp_init(3)