Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_sftp_seek64 (3ssh2)

Name

libssh2_sftp_seek64 - set the read/write position within a file

Synopsis

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

void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle,
libssh2_uint64_t offset);

Description

libssh2 manual                                      libssh2_sftp_seek64(3ssh2)



NAME
       libssh2_sftp_seek64 - set the read/write position within a file

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

       void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle,
                                libssh2_uint64_t offset);

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

       offset - Number of bytes from the beginning of file to seek to.

       Move  the file handle's internal pointer to an arbitrary location. lib-
       ssh2 implements file pointers as  a  localized  concept  to  make  file
       access appear more POSIX like. No packets are exchanged with the server
       during a seek operation. The localized file pointer is simply used as a
       convenience offset during read/write operations.

       You  MUST  NOT  seek during writing or reading a file with SFTP, as the
       internals use outstanding packets and changing the "file position" dur-
       ing transit will results in badness.

AVAILABILITY
       Added in 1.0


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)



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.0                       22 Dec 2008
                                                    libssh2_sftp_seek64(3ssh2)