libssh2_sftp_init - open SFTP channel for the given SSH session.
#include <libssh2.h> #include <libssh2_sftp.h> LIBSSH2_SFTP * libssh2_sftp_init(LIBSSH2_SESSION *session);
libssh2_sftp_init(3ssh2) libssh2 manual libssh2_sftp_init(3ssh2)
NAME
libssh2_sftp_init - open SFTP channel for the given SSH session.
SYNOPSIS
#include <libssh2.h> #include <libssh2_sftp.h>
LIBSSH2_SFTP * libssh2_sftp_init(LIBSSH2_SESSION *session);
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
Open a channel and initialize the SFTP subsystem. Although the SFTP
subsystem operates over the same type of channel as those exported by
the Channel API, the protocol itself implements its own unique binary
packet protocol which must be managed with the libssh2_sftp_*() family
of functions. When an SFTP session is complete, it must be destroyed
using the libssh2_sftp_shutdown(3) function.
RETURN VALUE
A pointer to the newly allocated SFTP instance or NULL on failure.
ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
LIBSSH2_ERROR_SOCKET_TIMEOUT -
LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was
received on the socket, or an SFTP operation caused an errorcode to be
returned by the server.
LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the call would
block.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_sftp_shutdown(3) libssh2_sftp_open_ex(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007 libssh2_sftp_init(3ssh2)