libssh2_sftp_open_ex man page on Archlinux

Printed from http://www.polarhome.com/service/man/?qf=libssh2_sftp_open_ex&af=0&tf=2&of=Archlinux

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 LIB‐
		     SSH2_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 cre‐
		     ated 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	 trun‐
		     cated  to	zero length when creating a file by specifying
		     LIBSSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also be	speci‐
		     fied 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 cre‐
       ated. See the LIBSSH2_SFTP_S_* convenience defines in <libssh2_sftp.h>

       open_type - Either of LIBSSH2_SFTP_OPENFILE (to open a  file)  or  LIB‐
       SSH2_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)
[top]

List of man pages available for Archlinux

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net