mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
50 lines
1.6 KiB
Groff
50 lines
1.6 KiB
Groff
.\" $Id: libssh2_sftp_fstat_ex.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $
|
|
.\"
|
|
.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_sftp_fstat_ex - get or set attributes on a file handle
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
int
|
|
libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat)
|
|
|
|
int
|
|
libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
|
|
|
|
int
|
|
libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
|
|
|
|
.SH DESCRIPTION
|
|
\fIhandle\fP - SFTP File Handle as returned by
|
|
.BR libssh2_sftp_open(3)
|
|
|
|
\fIattrs\fP - Pointer to attribute structure to set file metadata
|
|
from or into depending on the value of setstat.
|
|
|
|
\fIsetstat\fP - When non-zero, the file's metadata will be updated
|
|
with the data found in attrs according to the values of attrs->flags
|
|
and other relevant member attributes.
|
|
|
|
Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance.
|
|
|
|
.SH RETURN VALUE
|
|
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.
|
|
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
|
|
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
|
|
|
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
|
|
|
|
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
|
|
received on the socket, or an SFTP operation caused an errorcode to
|
|
be returned by the server.
|
|
|
|
.SH SEE ALSO
|
|
.BR libssh2_sftp_open(3)
|