libssh2/share/man/man3/libssh2_sftp_open_ex.3

   1 .\" $Id: libssh2_sftp_open_ex.3,v 1.8 2007/06/13 16:41:33 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_open -
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 LIBSSH2_SFTP_HANDLE *
  11 libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type);
  12
  13 LIBSSH2_SFTP_HANDLE *
  14 libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *filename, unsigned long flags, long mode);
  15
  16 LIBSSH2_SFTP_HANDLE *
  17 libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path);
  18
  19 .SH DESCRIPTION
  20 \fIsftp\fP - SFTP instance as returned by
  21 .BR libssh2_sftp_init(3)
  22
  23 \fIfilename\fP - Remote file/directory resource to open
  24
  25 \fIfilename_len\fP - Length of filename
  26
  27 \fIflags\fP - Any (reasonable) combination of the LIBSSH2_FXF_* constants
  28 corresponding fopen modes.
  29
  30 \fImode\fP - POSIX file permissions to assign if the file is being newly
  31 created.
  32
  33 \fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or
  34 LIBSSH2_SFTP_OPENDIR (to open a directory).
  35 .SH RETURN VALUE
  36 A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
  37 failure.
  38 .SH ERRORS
  39 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  40
  41 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  42
  43 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  44
  45 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  46 received on the socket, or an SFTP operation caused an errorcode to be
  47 returned by the server.
  48
  49 \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
  50
  51 .SH SEE ALSO
  52 .BR libssh_sftp_close(3)
  53