2007-04-22 19:18:03 +02:00
|
|
|
.\" $Id: libssh2_sftp_init.3,v 1.2 2007/04/22 17:18:03 jehousley Exp $
|
2007-02-02 17:09:12 +01:00
|
|
|
.\"
|
|
|
|
|
.TH libssh2_sftp_init 3 "23 Jan 2007" "libssh2 0.15" "libssh2 manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
libssh2_sftp_init -
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <libssh2.h>
|
2007-04-22 19:18:03 +02:00
|
|
|
#include <libssh2_sftp.h>
|
2007-02-02 17:09:12 +01:00
|
|
|
|
|
|
|
|
LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session);
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
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
|
|
|
|
|
\fIlibssh2_sftp_shutdown(3)\fP function.
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
A pointer to the newly allocated SFTP instance or NULL on failure.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BI libssh2_sftp_shutdown(3), libssh2_sftp_open_ex(3)
|
