1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_sftp_seek.md
Viktor Szakats 2b2664bfd4 include: add deprecated attributes where missing, related doc updates
- `libssh2_knownhost_add()`.
- `libssh2_poll_channel_read()`.
  Follow-up to 2b8038e175
- `libssh2_sftp_seek()`.
  Follow-up to 6875285b71
- `libssh2_sftp_tell()`.
  Follow-up to 8eba2961ac
- exclude `LIBSSH2_KNOWNHOST_KEY_SSHDSS` and `LIBSSH2_HOSTKEY_TYPE_DSS`
  macros when `LIBSSH2_NO_DEPRECATED` is set.
  They are both documented as deprecated in man pages.
- disable the above two features when building libssh2 with
  `LIBSSH2_NO_DEPRECATED`.
- TODO: add `libssh2_sign_sk()` for a future rename to
  `libssh2_userauth_sign_sk()`.
- TODO: add remark for `libssh2_session_flag()`.

Also considered `libssh2_session_flag()` which is marked for removal in
TODO (bab3a30220), but it's the only way
to enable compression, which is also used by curl. It needs an API
replacement to control compression, or perhaps only deprecate the rest
of flags.

Closes #1977
2026-06-05 11:38:06 +02:00

1.0 KiB

c, SPDX-License-Identifier, Title, Section, Source, See-also
c SPDX-License-Identifier Title Section Source See-also
Copyright (C) The libssh2 project and its contributors. BSD-3-Clause libssh2_sftp_seek 3 libssh2
libssh2_sftp_open_ex(3)
libssh2_sftp_seek64(3)

NAME

libssh2_sftp_seek - set the read/write position indicator within a file

SYNOPSIS

#include <libssh2.h>
#include <libssh2_sftp.h>

void libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle,
                       size_t offset);

DESCRIPTION

Deprecated function. Use libssh2_sftp_seek64(3) instead!

handle - SFTP File Handle as returned by libssh2_sftp_open_ex(3)

offset - Number of bytes from the beginning of file to seek to.

Move the file handle's internal pointer to an arbitrary location. Note that 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.

AVAILABILITY

Marked as deprecated since 1.2.8