libssh2_sftp_init.3 (1353B)
1.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_sftp_init - open SFTP channel for the given SSH session. 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7#include <libssh2_sftp.h> 8 9LIBSSH2_SFTP * 10libssh2_sftp_init(LIBSSH2_SESSION *session); 11.fi 12.SH DESCRIPTION 13\fIsession\fP - Session instance as returned by 14.BR libssh2_session_init_ex(3) 15 16Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem 17operates over the same type of channel as those exported by the Channel API, 18the protocol itself implements its own unique binary packet protocol which 19must be managed with the libssh2_sftp_*() family of functions. When an SFTP 20session is complete, it must be destroyed using the 21.BR libssh2_sftp_shutdown(3) 22function. 23.SH RETURN VALUE 24A pointer to the newly allocated SFTP instance or NULL on failure. 25.SH ERRORS 26\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 27 28\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 29 30\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 31 32\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 33received on the socket, or an SFTP operation caused an errorcode to be 34returned by the server. 35 36\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would 37block. 38.SH SEE ALSO 39.BR libssh2_sftp_shutdown(3) 40.BR libssh2_sftp_open_ex(3)