libssh2_sftp_readlink(3)

πŸ“¦
version 1.11.1 Β· 3 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, debian trixie, epel 10, epel 9, fedora 43, fedora 44, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

okay so this page is from the libssh2 manual, and it's literally about one tiny little macro that's out here doing the most for you πŸ’…


🌸 NAME 🌸

libssh2_sftp_readlink β€” it's a convenience macro for libssh2_sftp_symlink_ex(3), no cap


πŸŽ€ SYNOPSIS πŸŽ€

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

#define libssh2_sftp_readlink(sftp, path, target, maxlen) \
    libssh2_sftp_symlink_ex((sftp), (path), strlen(path), \
                            (target), (maxlen), \
                            LIBSSH2_SFTP_READLINK)

like… look at her. she's a macro. she's gorgeous. she does exactly one thing and she does it well 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜• β€” this is a macro, right, and she lives in a public libssh2 header file, out there in the open for everyone to see πŸ‘€

and underneath all that? she's just using the underlying function libssh2_sftp_symlink_ex(3). that's it. that's the whole vibe. she's a lil wrapper, a lil shortcut, the bestie who hands you the thing you actually needed so you don't have to type the long version yourself 😌


πŸ’– RETURN VALUE πŸ’–

go look at libssh2_sftp_symlink_ex(3), bestie β€” she's got the answers, fr fr


πŸ’€ ERRORS πŸ’€

same deal, same energy: see libssh2_sftp_symlink_ex(3) for all the error deets ✨


🌈 SEE ALSO 🌈


⚠️ real talk for one sec: this page tells you nothing on its own about what gets returned or what can go wrong β€” every single one of those answers is in libssh2_sftp_symlink_ex(3). so go read that one too, okay? it's not optional, it's required reading πŸ“š

and that's the whole page!! 🌟 this lil guy came from libssh2 1.2.4, dated 20 Feb 2010 (yes she's vintage, she's an icon, she's timeless πŸŽ€), and her manual page name is libssh2_sftp_readlink(3). slay, bye πŸ’–βœ¨πŸ¦‹