Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_sftp_tell (3ssh2)

Name

libssh2_sftp_tell - get the current read/write position indicator for a file

Synopsis

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

size_t libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle);

Description

libssh2_sftp_tell(3ssh2)        libssh2 manual        libssh2_sftp_tell(3ssh2)



NAME
       libssh2_sftp_tell - get the current read/write position indicator for a
       file

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

       size_t libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle);


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

       Returns the current offset of the file handle's internal pointer.  Note
       that  this  is  now  deprecated.  Use  the newer libssh2_sftp_tell64(3)
       instead!

RETURN VALUE
       Current offset from beginning of file in bytes.


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


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

SEE ALSO
       libssh2_sftp_open_ex(3), libssh2_sftp_tell64(3)



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 0.15                      1 Jun 2007          libssh2_sftp_tell(3ssh2)