libssh2_sftp_open_ex(3) [centos man page]

libssh2_sftp_open_ex(3) 					  libssh2 manual					   libssh2_sftp_open_ex(3)

NAME

       libssh2_sftp_open - open filehandle for file on SFTP.

SYNOPSIS

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

       LIBSSH2_SFTP_HANDLE *
       libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename,
			    unsigned int filename_len, unsigned long flags,
			    long mode, int open_type);

DESCRIPTION

       sftp - SFTP instance as returned by libssh2_sftp_init(3)

       filename - Remote file/directory resource to open

       filename_len - Length of filename

       flags - Any reasonable combination of the LIBSSH2_FXF_* constants:

	      LIBSSH2_FXF_READ
		     Open the file for reading.

	      LIBSSH2_FXF_WRITE
		     Open the file for writing.  If both this and LIBSSH2_FXF_READ are specified, the file is opened for both reading and writing.

	      LIBSSH2_FXF_APPEND
		     Force all writes to append data at the end of the file.

	      LIBSSH2_FXF_CREAT,
		     If  this flag is specified, then a new file will be created if one does not already exist (if LIBSSH2_FXF_TRUNC is specified,
		     the new file will be truncated to zero length if it previously exists)

	      LIBSSH2_FXF_TRUNC
		     Forces an existing file with the same name to  be	truncated  to  zero  length  when  creating  a	file  by  specifying  LIB-
		     SSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also be specified if this flag is used.

	      LIBSSH2_FXF_EXCL
		     Causes the request to fail if the named file already exists.  LIBSSH2_FXF_CREAT MUST also be specified if this flag is used.

       mode  -	POSIX  file  permissions  to  assign  if  the  file  is being newly created. See the LIBSSH2_SFTP_S_* convenience defines in <lib-
       ssh2_sftp.h>

       open_type - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or LIBSSH2_SFTP_OPENDIR (to open a directory).

RETURN VALUE

       A pointer to the newly created LIBSSH2_SFTP_HANDLE 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_close_handle(3)

libssh2 0.15							    1 Jun 2007						   libssh2_sftp_open_ex(3)

libssh2_sftp_readdir_ex(3)					  libssh2 manual					libssh2_sftp_readdir_ex(3)

NAME

       libssh2_sftp_readdir_ex - read directory data from an SFTP handle

SYNOPSIS

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

       int
       libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle,
			       char *buffer, size_t buffer_maxlen,
			       char *longentry, size_t longentry_maxlen,
			       LIBSSH2_SFTP_ATTRIBUTES *attrs);

DESCRIPTION

       Reads a block of data from a LIBSSH2_SFTP_HANDLE and returns file entry information for the next entry, if any.

       handle - is the SFTP File Handle as returned by libssh2_sftp_open_ex(3)

       buffer - is a pointer to a pre-allocated buffer of at least buffer_maxlen bytes to read data into.

       buffer_maxlen  - is the length of buffer in bytes. If the length of the filename is longer than the space provided by buffer_maxlen it will
       be truncated to fit.

       longentry - is a pointer to a pre-allocated buffer of at least longentry_maxlen bytes to read data into. The format of the `longname' field
       is  unspecified by SFTP protocol. It MUST be suitable for use in the output of a directory listing command (in fact, the recommended opera-
       tion for a directory listing command is to simply display this data).

       longentry_maxlen - is the length of longentry in bytes. If the length of the full directory entry is longer than the space provided by lon-
       gentry_maxlen it will be truncated to fit.

       attrs - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate statbuf style data into.

RETURN VALUE

       Number  of  bytes  actually  populated  into  buffer  (not  counting  the  terminating  zero),  or  negative  on  failure.  It returns LIB-
       SSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.

BUG

       Passing in a too small buffer for 'buffer' or 'longentry' when receiving data only results in libssh2 1.2.7 or  earlier	to  not  copy  the
       entire data amount, and it is not possible for the application to tell when it happens!

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.

       From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if any of the given 'buffer' or  'longentry'  buffers  are  too  small  to  fit  the
       requested object name.

SEE ALSO

       libssh2_sftp_open_ex(3), libssh2_sftp_close_handle(3)

libssh2 0.15							    1 Jun 2007						libssh2_sftp_readdir_ex(3)