libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2"
4
.SH NAME
5
libssh2_sftp_seek - set the read/write position indicator within a file
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
void
12
libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle,
13
                  size_t offset);
14
.fi
15
.SH DESCRIPTION
16
Deprecated function. Use \fIlibssh2_sftp_seek64(3)\fP instead!
17

18
\fIhandle\fP - SFTP File Handle as returned by
19
.BR libssh2_sftp_open_ex(3)
20

21
\fIoffset\fP - Number of bytes from the beginning of file to seek to.
22

23
Move the file handle's internal pointer to an arbitrary location.
24
Note that libssh2 implements file pointers as a localized concept to make
25
file access appear more POSIX like. No packets are exchanged with the server
26
during a seek operation. The localized file pointer is used as a convenience
27
offset during read/write operations.
28
.SH SEE ALSO
29
.BR libssh2_sftp_open_ex(3),
30
.BR libssh2_sftp_seek64(3)
31