libssh2_userau...tbased_fromfile(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

πŸ’– libssh2_userauth_hostbased_fromfile β€” the girlies' guide πŸ’–

okay bestie, so this one lives in the libssh2 manual, and it's honestly the shortest little baddie you'll ever meet. no cap. πŸŽ€


✨ NAME ✨

libssh2_userauth_hostbased_fromfile β€” it's giving "convenience macro", and it exists purely to make calls to libssh2_userauth_hostbased_fromfile_ex(3) easier. that's the whole vibe. πŸ¦‹


✨ SYNOPSIS ✨

#include <libssh2.h>

int
libssh2_userauth_hostbased_fromfile(LIBSSH2_SESSION *session,
                                    const char *username,
                                    const char *publickey,
                                    const char *privatekey,
                                    const char *passphrase,
                                    const char *hostname);

look at that parameter list. six little arguments, all lined up, main character energy. πŸ’…


✨ DESCRIPTION ✨

so here's the tea πŸ“: this is not a full-blown function, bestie. it's a macro β€” and it's defined in a public libssh2 header file, so it's just sitting there ready for you. and what does that macro do? it's out here using the underlying function libssh2_userauth_hostbased_fromfile_ex(3). that's it. that's the whole job. the macro is the cute little wrapper, the _ex function is the one doing the actual heavy lifting. iykyk. ✨


✨ RETURN VALUE ✨

ngl, this one doesn't do its own thing here β€” it says See libssh2_userauth_hostbased_fromfile_ex(3). go peek at that page, it's got the answers. πŸ‘‘


✨ ERRORS ✨

same situation, bestie β€” See libssh2_userauth_hostbased_fromfile_ex(3). the _ex page is holding all the error lore. 🫢


✨ SEE ALSO ✨


real talk: since this page keeps pointing you at libssh2_userauth_hostbased_fromfile_ex(3) for the return values and the errors, that page is your actual bestie for the details. this one's just the intro. πŸ™ˆ

mwah πŸ’‹ that's the whole page, and it came straight out of libssh2 1.2.4, dated 20 Feb 2010. slay, you're done, go read the _ex page now βœ¨πŸ’œ