libssh2/share/man/man3/libssh2_sftp_fstat_ex.3

   1 .\" $Id: libssh2_sftp_fstat_ex.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_fstat_ex - get or set attributes on a file handle
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 int
  11 libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat)
  12
  13 int
  14 libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
  15
  16 int
  17 libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
  18
  19 .SH DESCRIPTION
  20 \fIhandle\fP - SFTP File Handle as returned by
  21 .BR libssh2_sftp_open(3)
  22
  23 \fIattrs\fP - Pointer to attribute structure to set file metadata
  24 from or into depending on the value of setstat.
  25
  26 \fIsetstat\fP - When non-zero, the file's metadata will be updated
  27 with the data found in attrs according to the values of attrs->flags
  28 and other relevant member attributes.
  29
  30 Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance.
  31
  32 .SH RETURN VALUE
  33 Return 0 on success or negative on failure.  It returns
  34 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  35 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  36
  37 .SH ERRORS
  38 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  39
  40 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  41
  42 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  43
  44 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  45 received on the socket, or an SFTP operation caused an errorcode to
  46 be returned by the server.
  47
  48 .SH SEE ALSO
  49 .BR libssh2_sftp_open(3)