libssh2/share/man/man3/libssh2_sftp_seek.3

   1 .\" $Id: libssh2_sftp_seek.3,v 1.1 2007/06/14 16:08:43 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_seek 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_seek - set the read/write position indicator within a file
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 void
  11 libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, size_t offset);
  12
  13 .SH DESCRIPTION
  14 \fIhandle\fP - SFTP File Handle as returned by
  15 .BR libssh2_sftp_open(3)
  16
  17 \fIoffset\fP - Number of bytes from the beginning of file to seek to.
  18
  19 Move the file handle's internal pointer to an arbitrary location.
  20 Note that libssh2 implements file pointers as a localized concept to make
  21 file access appear more POSIX like. No packets are exchanged with the server
  22 during a seek operation. The localized file pointer is simply used as a
  23 convenience offset during read/write operations.
  24
  25 .SH SEE ALSO
  26 .BR libssh2_sftp_open(3)