libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_sftp_init - open SFTP channel for the given SSH session.
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
LIBSSH2_SFTP *
12
libssh2_sftp_init(LIBSSH2_SESSION *session);
13
.fi
14
.SH DESCRIPTION
15
\fIsession\fP - Session instance as returned by
16
.BR libssh2_session_init_ex(3)
17

18
Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem
19
operates over the same type of channel as those exported by the Channel API,
20
the protocol itself implements its own unique binary packet protocol which
21
must be managed with the libssh2_sftp_*() family of functions. When an SFTP
22
session is complete, it must be destroyed using the
23
.BR libssh2_sftp_shutdown(3)
24
function.
25
.SH RETURN VALUE
26
A pointer to the newly allocated SFTP instance or NULL on failure.
27
.SH ERRORS
28
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
29

30
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
31

32
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
33

34
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - 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
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
39
block.
40
.SH SEE ALSO
41
.BR libssh2_sftp_shutdown(3)
42
.BR libssh2_sftp_open_ex(3)
43