libssh2_knownhost_get(3)

💖 libssh2_knownhost_get — get a known host off the collection of known hosts 💖

okay bestie, welcome to the libssh2_knownhost_get(3) page — this is the part of the libssh2 manual where we learn how to walk through your whole known-hosts collection one lil entry at a time. it's giving loop energy. let's get into it 🦋

✨ SYNOPSIS ✨

#include <libssh2.h>

int
libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts,
                      struct libssh2_knownhost **store,
                      struct libssh2_knownhost *prev):

🌸 DESCRIPTION 🌸

so libssh2_knownhost_get(3) lets your application iterate over all known hosts in the collection. like, one at a time, no cap. it's the lil cursor that walks the whole list for you 🚶♀️✨

• store should point to a pointer that gets filled in to point to the known host data. so it's a pointer-to-a-pointer, yes, we know, it's a lot, but she's doing her job 💅
• prev is a pointer to a previous struct libssh2_knownhost as returned by a previous invoke of this function, or NULL to get the first entry in the internal collection. so: pass NULL first, then keep feeding back what you got, and you'll glide through the whole thing 🌈

fr fr, that prev value has to come from a previous invoke of this function — that's how she knows where she left off. iykyk.

👑 RETURN VALUE 👑

• Returns 0 if everything is fine and information about a host was stored in the store struct. slay. 🎀
• Returns 1 if it reached the end of hosts. that's your cue that the collection is done, bestie, not an error. 💀
• Returns negative values for error. yeah. negative = something went sideways. 😭

🦋 AVAILABILITY 🦋

Added in libssh2 1.2. so she's been iconic since way back ⭐

🫶 SEE ALSO 🫶

• libssh2_knownhost_readfile(3)
• libssh2_knownhost_writefile(3)
• libssh2_knownhost_add(3)

libssh2 · 28 May 2009 — that's the source/version and the date, babes, signing off 💖 go iterate over your hosts, you main character, periodt ✨🌸