GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LIBSSH2_SFTP_INIT (3)

NAME

libssh2_sftp_init - open SFTP channel for the given SSH session.

CONTENTS

Synopsis
Description
Return Value
Errors
See Also

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.

SEE ALSO

libssh2_sftp_shutdown(3) libssh2_sftp_open_ex(3)
Search for    or go to Top of page |  Section 3 |  Main Index


libssh2 0.15 LIBSSH2_SFTP_INIT (3) 1 Jun 2007

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.