libssh2_session_set_last_error(3)

💅 libssh2_session_set_last_error — bestie, let's fix that error state

okay so this one is from the libssh2 manual, and it's genuinely one of those "iykyk" little functions. Its whole job? sets the internal error state ✨

🎀 SYNOPSIS

#include <libssh2.h>

int
libssh2_session_set_last_error(LIBSSH2_SESSION *session,
                               int errcode, const char *errmsg)

🌸 DESCRIPTION

Here's the tea, ingredient by ingredient:

• session — the session instance, aka the thing you got back from libssh2_session_init_ex(3) 🫶
• errcode — one of the error codes as defined in the public libssh2 header file. Pick your fighter.
• errmsg — if this is not NULL, a copy of the given string gets stored inside the session object as the error message. A little souvenir. A lil note-to-self. 💌

So who is this function for? Not your average C gremlin, actually — it's provided for high level language wrappers (i.e. Python or Perl) and other libraries that may extend libssh2 with additional features while still relying on its error reporting mechanism. Basically: you're building on top of libssh2, you've got your own extra stuff going on, but you still want everybody's error handling to vibe on the same wavelength. Iconic, honestly. 👑

⭐ RETURN VALUE

A numeric error code corresponding to the the Error Code constants. Yep, that's the whole thing. Not me noticing the original says "the the" — keeping it, no cap, character for character. 🙈

🦋 AVAILABILITY

Added in 1.6.1. So if you're on something older, it's giving "not invited to the party". 💀

🌈 SEE ALSO

• libssh2_session_last_error(3)
• libssh2_session_last_errno(3)

💖 reminder bestie: that errmsg only gets copied in if it's not NULL. Don't go passing a null pointer and expecting a cute little message to appear. The manpage said what it said.

okay and that's the whole page, slay 💅 thanks for reading all the way to the end — this masterpiece dropped 26 Oct 2015, courtesy of the libssh2 manual, and yes, it ate. periodt. 🍓🧚✨