mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-22 00:45:51 +03:00
f6aa31f48f
- All files have prominent copyright and SPDX identifier - If not embedded in the file, in the .reuse/dep5 file - All used licenses are in LICENSES/ (not shipped in tarballs) - A new REUSE CI job verify that all files are OK Assisted-by: Viktor Szakats Closes #1084
34 lines
1.1 KiB
Groff
34 lines
1.1 KiB
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_sftp_seek64 - set the read/write position within a file
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
void
|
|
libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle,
|
|
libssh2_uint64_t offset);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIhandle\fP - SFTP File Handle as returned by
|
|
.BR libssh2_sftp_open_ex(3)
|
|
|
|
\fIoffset\fP - Number of bytes from the beginning of file to seek to.
|
|
|
|
Move the file handle's internal pointer to an arbitrary location. libssh2
|
|
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 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" during transit will
|
|
results in badness.
|
|
.SH AVAILABILITY
|
|
Added in 1.0
|
|
.SH SEE ALSO
|
|
.BR libssh2_sftp_open_ex(3)
|