1libssh2_sftp_init(3)                libssh2               libssh2_sftp_init(3)
2
3
4

NAME

6       libssh2_sftp_init - open SFTP channel for the given SSH session.
7

SYNOPSIS

9       #include <libssh2.h>
10       #include <libssh2_sftp.h>
11
12       LIBSSH2_SFTP *
13       libssh2_sftp_init(LIBSSH2_SESSION *session);
14

DESCRIPTION

16       session - Session instance as returned by libssh2_session_init_ex(3)
17
18       Open  a  channel  and  initialize the SFTP subsystem. Although the SFTP
19       subsystem operates over the same type of channel as those  exported  by
20       the  Channel  API, the protocol itself implements its own unique binary
21       packet protocol which must be managed with the libssh2_sftp_*()  family
22       of  functions.  When  an SFTP session is complete, it must be destroyed
23       using the libssh2_sftp_shutdown(3) function.
24

RETURN VALUE

26       A pointer to the newly allocated SFTP instance or NULL on failure.
27

ERRORS

29       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.
30
31       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
32
33       LIBSSH2_ERROR_SOCKET_TIMEOUT -
34
35       LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was re‐
36       ceived  on  the  socket, or an SFTP operation caused an errorcode to be
37       returned by the server.
38
39       LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the  call  would
40       block.
41

SEE ALSO

43       libssh2_sftp_shutdown(3) libssh2_sftp_open_ex(3)
44
45
46
47libssh2 0.15                      1 Jun 2007              libssh2_sftp_init(3)
Impressum