libssh2_channel_open_ex(3) [debian man page]

libssh2_channel_open_ex(3)					  libssh2 manual					libssh2_channel_open_ex(3)

NAME

       libssh2_channel_open_ex - establish a generic session channel

SYNOPSIS

       #include <libssh2.h>

       LIBSSH2_CHANNEL	*  libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int
       window_size, unsigned int packet_size, const char *message, unsigned int message_len);

       LIBSSH2_CHANNEL * libssh2_channel_open_session(session);

DESCRIPTION

       session - Session instance as returned by libssh2_session_init_ex(3)

       channel_type - Channel type to open. Typically one of session, direct-tcpip, or tcpip-forward. The SSH2	protocol  allowed  for	additional
       types including local, custom channel types.

       channel_type_len - Length of channel_type

       window_size  -  Maximum	amount	of  unacknowledged  data  remote host is allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST
       packet.

       packet_size - Maximum number of bytes remote host is allowed to send in	a  single  SSH_MSG_CHANNEL_DATA  or  SSG_MSG_CHANNEL_EXTENDED_DATA
       packet.

       message - Additional data as required by the selected channel_type.

       message_len - Length of message parameter.

       Allocate  a  new  channel  for  exchanging  data with the server. This method is typically called through its macroized form: libssh2_chan-
       nel_open_session(3) or via libssh2_channel_direct_tcpip(3) or libssh2_channel_forward_listen(3)

RETURN VALUE

       Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.

ERRORS

       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_CHANNEL_FAILURE -

       LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the call would block.

SEE ALSO

       Add related functions

libssh2 0.15							    1 Jun 2007						libssh2_channel_open_ex(3)

libssh2_sftp_stat_ex(3) 					  libssh2 manual					   libssh2_sftp_stat_ex(3)

NAME

       libssh2_sftp_stat_ex - get status about an SFTP file

SYNOPSIS

       #include <libssh2.h>
       #include <libssh2_sftp.h>

       int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path,
				unsigned int path_len, int stat_type,
				LIBSSH2_SFTP_ATTRIBUTES *attrs);

DESCRIPTION

       sftp - SFTP instance as returned by libssh2_sftp_init(3)

       path - Remote filesystem object to stat/lstat/setstat.

       path_len - Length of the name of the remote filesystem object to stat/lstat/setstat.

       stat_type - One of the three constants specifying the type of stat operation to perform:

       LIBSSH2_SFTP_STAT: performs stat(2) operation
       LIBSSH2_SFTP_LSTAT: performs lstat(2) operation
       LIBSSH2_SFTP_SETSTAT: performs operation to set stat info on file

       attrs - Pointer to a LIBSSH2_SFTP_ATTRIBUTES structure to set file metadata from or into depending on the value of stat_type.

       Get or Set statbuf type data on a remote filesystem object. When getting statbuf data, libssh2_sftp_stat(3) will follow all symlinks, while
       libssh2_sftp_lstat(3) will return data about the object encountered, even if that object happens to be a symlink.

       The LIBSSH2_SFTP_ATTRIBUTES struct looks like this:

       struct LIBSSH2_SFTP_ATTRIBUTES {
	   /* If flags & ATTR_* bit is set, then the value in this struct will be
	    * meaningful Otherwise it should be ignored
	    */
	   unsigned long flags;

	   libssh2_uint64_t filesize;
	   unsigned long uid;
	   unsigned long gid;
	   unsigned long permissions;
	   unsigned long atime;
	   unsigned long mtime;
       };

RETURN VALUE

       Returns 0 on success or negative on failure.  It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN	is
       a negative number, it isn't really a failure per se.

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.

SEE ALSO

       libssh2_sftp_init(3)

libssh2 0.15							    1 Jun 2007						   libssh2_sftp_stat_ex(3)