libssh2_sftp_unlink_ex.3 (1242B)
1.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_sftp_unlink_ex - unlink an SFTP file 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7#include <libssh2_sftp.h> 8 9int 10libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); 11 12int 13libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); 14.fi 15.SH DESCRIPTION 16\fIsftp\fP - SFTP instance as returned by 17.BR libssh2_sftp_init(3) 18 19\fIfilename\fP - Path and name of the existing filesystem entry 20 21\fIfilename_len\fP - Length of the path and name of the existing 22filesystem entry 23 24Unlink (delete) a file from the remote filesystem. 25.SH RETURN VALUE 26Return 0 on success or negative on failure. It returns 27LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 28LIBSSH2_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 37received on the socket, or an SFTP operation caused an errorcode to 38be returned by the server. 39.SH SEE ALSO 40.BR libssh2_sftp_init(3)