libssh2/share/man/man3/libssh2_sftp_stat_ex.3

   1 .\" $Id: libssh2_sftp_stat_ex.3,v 1.1 2007/06/14 16:33:38 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_stat_ex - rename a file
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 int
  11 libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs);
  12
  13 int
  14 libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
  15
  16 int
  17 libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
  18
  19 int
  20 libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
  21
  22 .SH DESCRIPTION
  23 \fIsftp\fP - SFTP instance as returned by
  24 .BR libssh2_sftp_init(3)
  25
  26 \fIpath\fP - Remote filesystem object to stat/lstat/setstat.
  27
  28 \fIpath_len\fP - Lenght of the name of the remote filesystem object
  29 to stat/lstat/setstat.
  30
  31 \fIstat_type\fP - One of the three constants specifying the type of
  32 stat operation to perform.
  33
  34 \fIattrs\fP - Pointer to attribute structure to set file metadata
  35 from or into depending on the value of stat_type.
  36
  37 Get or Set statbuf type data on a remote filesystem object. When
  38 getting statbuf data,
  39 .BR libssh2_sftp_stat(3)
  40 will follow all symlinks, while
  41 .BR libssh2_sftp_lstat(3)
  42 will return data about the object encountered, even if that object
  43 happens to be a symlink.
  44
  45 .SH RETURN VALUE
  46 Return 0 on success or negative on failure.  It returns
  47 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  48 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  49
  50 .SH ERRORS
  51 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  52
  53 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  54
  55 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  56
  57 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  58 received on the socket, or an SFTP operation caused an errorcode to
  59 be returned by the server.
  60
  61 .SH SEE ALSO
  62 .BR libssh2_sftp_init(3)