Update to match current code and add errors
Этот коммит содержится в:
родитель
3fbdf1a644
Коммит
72c8408a40
@ -1,4 +1,4 @@
|
||||
.\" $Id: libssh2_sftp_init.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $
|
||||
.\" $Id: libssh2_sftp_init.3,v 1.5 2007/06/13 14:23:46 jehousley Exp $
|
||||
.\"
|
||||
.TH libssh2_sftp_init 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
||||
.SH NAME
|
||||
@ -7,18 +7,35 @@ libssh2_sftp_init -
|
||||
#include <libssh2.h>
|
||||
#include <libssh2_sftp.h>
|
||||
|
||||
LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session);
|
||||
LIBSSH2_SFTP *
|
||||
libssh2_sftp_init(LIBSSH2_SESSION *session);
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fIsession\fP - Session instance as returned by
|
||||
.BR libssh2_session_init(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
|
||||
\fIlibssh2_sftp_shutdown(3)\fP function.
|
||||
.BR libssh2_sftp_shutdown(3)
|
||||
function.
|
||||
.SH RETURN VALUE
|
||||
A pointer to the newly allocated SFTP instance or NULL on failure.
|
||||
.SH ERRORS
|
||||
LIBSSH2_ERROR_EAGAIN
|
||||
Marked for non-blocking I/O but the call would block.
|
||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||
|
||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||
|
||||
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
|
||||
|
||||
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
|
||||
received on the socket, or an SFTP operation caused an errorcode to be
|
||||
returned by the server.
|
||||
|
||||
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BI libssh2_sftp_shutdown(3), libssh2_sftp_open_ex(3)
|
||||
.BR libssh2_sftp_shutdown(3)
|
||||
.BR libssh2_sftp_open_ex(3)
|
||||
|
Загрузка…
x
Ссылка в новой задаче
Block a user