libssh2_sftp_symlink(3)
π libssh2_sftp_symlink β bestie's guide to the shortcut β¨
ok so real talk, we're in the libssh2 manual, section 3, and this page is literally about one tiny macro. it's giving "short but iconic" π
πΈ NAME πΈ
libssh2_sftp_symlink β it's a convenience macro for libssh2_sftp_symlink_ex(3). that's it, that's the whole thing, no cap π«Ά
β¨ SYNOPSIS β¨
#include <libssh2.h>
#include <libssh2_sftp.h>
#define libssh2_sftp_symlink(sftp, orig, linkpath) \
libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \
strlen(linkpath), LIBSSH2_SFTP_SYMLINK)
π¦ DESCRIPTION π¦
so here's the tea β: this is a macro, not a real function, and it lives in a public libssh2 header file. it exists purely to be a glow-up wrapper around the actual workhorse function, libssh2_sftp_symlink_ex(3).
the way it eats: you hand it sftp, orig, and linkpath, and it quietly does the strlen() math on both orig and linkpath for you, then calls through with LIBSSH2_SFTP_SYMLINK. so you get the vibes of a simple two-string call without typing all that out yourself. main character convenience energy, honestly π
π RETURN VALUE π
no thoughts of its own, bestie β go read libssh2_sftp_symlink_ex(3) for that. it's the one holding the receipts.
π ERRORS π
same deal, fr fr. errors are libssh2_sftp_symlink_ex(3)'s whole personality. check over there.
π₯ SEE ALSO π₯
mwah π that's the page. this gem came out of libssh2 1.2.4, dated 20 Feb 2010 β yes she's vintage, yes she still slays. take care of her, go make some symlinks, and remember: read the _ex page for literally everything important π§π
π¦ where this page comes from
- alpine 3.22: libssh2-doc 1.11.1-r3 Β· BSD-3-Clause
- alpine 3.23: libssh2-doc 1.11.1-r4 Β· BSD-3-Clause
- alpine 3.24: libssh2-doc 1.11.1-r4 Β· BSD-3-Clause
- arch rolling: libssh2 1.11.1-7 Β· BSD-3-Clause
- debian trixie: libssh2-1-dev 1.11.1-1+deb13u1 Β· BSD3
- debian trixie: libssh2-1-dev 1.11.1-1+deb13u2 Β· BSD3
- epel 10: libssh2-docs 1.11.1-9.el10_3 Β· BSD-3-Clause
- epel 9: libssh2-docs 1.11.1-9.el9 Β· BSD-3-Clause
- fedora 43: libssh2-docs 1.11.1-4.fc43 Β· BSD-3-Clause
- fedora 43: libssh2-docs 1.11.1-9.fc43 Β· BSD-3-Clause
- fedora 44: libssh2-docs 1.11.1-5.fc44 Β· BSD-3-Clause
- fedora 44: libssh2-docs 1.11.1-9.fc44 Β· BSD-3-Clause
- opensuse-leap 16.0: libssh2-devel 1.11.1-160000.5.1 Β· BSD-3-Clause
- opensuse-leap 16.0: libssh2-devel 1.11.1-160000.5.1 Β· BSD-3-Clause
- opensuse-leap 16.0: libssh2-devel 1.11.1-160000.5.1 Β· BSD-3-Clause
- opensuse-leap 16.0: libssh2-devel 1.11.1-160000.5.1 Β· BSD-3-Clause
- ubuntu questing: libssh2-1-dev 1.11.1-1build1
- ubuntu questing: libssh2-1-dev 1.11.1-1ubuntu0.25.10.2
- ubuntu resolute: libssh2-1-dev 1.11.1-1build2 Β· BSD3
- ubuntu resolute: libssh2-1-dev 1.11.1-1ubuntu0.26.04.4 Β· BSD3
- ubuntu stonking: libssh2-1-dev 1.11.1-6 Β· BSD3
- π the page's license: BSD-3-Clause
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms