libssh2/share/man/man3/libssh2_sftp_tell.3

   1 .\" $Id: libssh2_sftp_tell.3,v 1.1 2007/06/14 16:33:38 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_tell - get the current read/write position indicator for a file
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 size_t
  11 libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle);
  12
  13 .SH DESCRIPTION
  14 \fIhandle\fP - SFTP File Handle as returned by
  15 .BR libssh2_sftp_open(3)
  16
  17 Identify the current offset of the file handle's internal pointer. Note
  18 that the SSH2 protocol does not have a notion of file pointers and that
  19 libssh2 implements this using a localized file pointer which is updated
  20 with each read/write call.
  21
  22 .SH RETURN VALUE
  23 Current offset from beginning of file in bytes.
  24
  25 .SH SEE ALSO
  26 .BR libssh2_sftp_open(3)