1libssh2_sftp_init(3)            libssh2 manual            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> #include <libssh2_sftp.h>
10
11       LIBSSH2_SFTP * libssh2_sftp_init(LIBSSH2_SESSION *session);
12
13

DESCRIPTION

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

RETURN VALUE

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

ERRORS

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

SEE ALSO

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