libssh2_sftp_seek64.3 1.0 KB

1234567891011121314151617181920212223242526272829
  1. .TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual"
  2. .SH NAME
  3. libssh2_sftp_seek64 - set the read/write position within a file
  4. .SH SYNOPSIS
  5. .nf
  6. #include <libssh2.h>
  7. #include <libssh2_sftp.h>
  8. void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle,
  9. libssh2_uint64_t offset);
  10. .SH DESCRIPTION
  11. \fIhandle\fP - SFTP File Handle as returned by
  12. .BR libssh2_sftp_open_ex(3)
  13. \fIoffset\fP - Number of bytes from the beginning of file to seek to.
  14. Move the file handle's internal pointer to an arbitrary location. libssh2
  15. implements file pointers as a localized concept to make file access appear
  16. more POSIX like. No packets are exchanged with the server during a seek
  17. operation. The localized file pointer is simply used as a convenience offset
  18. during read/write operations.
  19. You MUST NOT seek during writing or reading a file with SFTP, as the internals
  20. use outstanding packets and changing the "file position" during transit will
  21. results in badness.
  22. .SH AVAILABILITY
  23. Added in 1.0
  24. .SH SEE ALSO
  25. .BR libssh2_sftp_open_ex(3)