libssh2_sftp_fstat_ex

Section: libssh2 manual (3)
Updated: 1 Jun 2007
Index Return to Main Contents
 

NAME

libssh2_sftp_fstat_ex - get or set attributes on a file handle  

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)

 

DESCRIPTION

handle - SFTP File Handle as returned by libssh2_sftp_open_ex(3)

attrs - Pointer to attribute structure to set file metadata from or into depending on the value of setstat.

setstat - 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.  

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.  

ERRORS

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

LIBSSH2_ERROR_SOCKET_TIMEOUT -

LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server.  

SEE ALSO

libssh2_sftp_open_ex(3)