Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_sftp_fsync (3ssh2)

Name

libssh2_sftp_fsync - synchronize file to disk

Synopsis

#include <libssh2.h>
#include <libssh2_sftp.h>

int
libssh2_sftp_fsync(LIBSSH2_SFTP_HANDLE *handle)

Description

libssh2_sftp_fsync(3ssh2)       libssh2 manual       libssh2_sftp_fsync(3ssh2)



NAME
       libssh2_sftp_fsync - synchronize file to disk

SYNOPSIS
       #include <libssh2.h>
       #include <libssh2_sftp.h>

       int
       libssh2_sftp_fsync(LIBSSH2_SFTP_HANDLE *handle)

DESCRIPTION
       This function causes the remote server to synchronize the file data and
       metadata to disk (like fsync(2)).

       For this to work requires fsync@openssh.com support on the server.

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


RETURN VALUE
       Returns 0 on success or negative on failure. If  used  in  non-blocking
       mode,  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_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.  In particular, this can be returned if the SSH
       server does not support the fsync  operation:  the  SFTP  subcode  LIB-
       SSH2_FX_OP_UNSUPPORTED will be returned in this case.


AVAILABILITY
       Added in libssh2 1.4.4 and OpenSSH 6.3.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       fsync(2)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 1.4.4                     8 Apr 2013         libssh2_sftp_fsync(3ssh2)