generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

libssh2_sftp_stat_ex.3: cleaned up, extended

Browse Source 
Removed the macros from it as they have their own man pages.

Added the LIBSSH2_SFTP_ATTRIBUTES struct in here for easier reference.
This commit is contained in:
Daniel Stenberg 2011-01-06 00:30:32 +01:00
parent 164838c7dd
commit 7015488150
1 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/libssh2_sftp_stat_ex.3
View File

@ -4,21 +4,13 @@
.SH NAME .SH NAME
libssh2_sftp_stat_ex - get status about an SFTP file libssh2_sftp_stat_ex - get status about an SFTP file
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
#include <libssh2_sftp.h> #include <libssh2_sftp.h>
int int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path,
libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs); unsigned int path_len, int stat_type,
LIBSSH2_SFTP_ATTRIBUTES *attrs);
int
libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
int
libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
int
libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
.SH DESCRIPTION .SH DESCRIPTION
\fIsftp\fP - SFTP instance as returned by \fIsftp\fP - SFTP instance as returned by
.BR libssh2_sftp_init(3) .BR libssh2_sftp_init(3)
@ -29,7 +21,8 @@ libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUT
to stat/lstat/setstat. to stat/lstat/setstat.
\fIstat_type\fP - One of the three constants specifying the type of \fIstat_type\fP - One of the three constants specifying the type of
stat operation to perform. stat operation to perform:
.br .br
\fBLIBSSH2_SFTP_STAT\fP: performs stat(2) operation \fBLIBSSH2_SFTP_STAT\fP: performs stat(2) operation
.br .br
@ -37,22 +30,38 @@ stat operation to perform.
.br .br
\fBLIBSSH2_SFTP_SETSTAT\fP: performs operation to set stat info on file \fBLIBSSH2_SFTP_SETSTAT\fP: performs operation to set stat info on file
\fIattrs\fP - Pointer to attribute structure to set file metadata \fIattrs\fP - Pointer to a \fBLIBSSH2_SFTP_ATTRIBUTES\fP structure to set file
from or into depending on the value of stat_type. metadata from or into depending on the value of stat_type.
Get or Set statbuf type data on a remote filesystem object. When Get or Set statbuf type data on a remote filesystem object. When getting
getting statbuf data, statbuf data,
.BR libssh2_sftp_stat(3) .BR libssh2_sftp_stat(3)
will follow all symlinks, while will follow all symlinks, while
.BR libssh2_sftp_lstat(3) .BR libssh2_sftp_lstat(3)
will return data about the object encountered, even if that object will return data about the object encountered, even if that object
happens to be a symlink. happens to be a symlink.
.SH RETURN VALUE The LIBSSH2_SFTP_ATTRIBUTES struct looks like this:
Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.nf
struct LIBSSH2_SFTP_ATTRIBUTES {
/* If flags & ATTR_* bit is set, then the value in this struct will be
* meaningful Otherwise it should be ignored
*/
unsigned long flags;
libssh2_uint64_t filesize;
unsigned long uid;
unsigned long gid;
unsigned long permissions;
unsigned long atime;
unsigned long mtime;
};
.fi
.SH RETURN VALUE
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
@ -63,6 +72,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
received on the socket, or an SFTP operation caused an errorcode to received on the socket, or an SFTP operation caused an errorcode to
be returned by the server. be returned by the server.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_sftp_init(3) .BR libssh2_sftp_init(3)