libssh2_session_last_error(3)

💖 libssh2_session_last_error(3) 💖

okay bestie, this is a page from the libssh2 manual and it's literally about finding out what just went wrong — like a little detective for your session's most recent oopsie 🕵️♀️✨

🌸 NAME 🌸

libssh2_session_last_error — get the most recent error 💅

✨ SYNOPSIS ✨

#include <libssh2.h>

int
libssh2_session_last_error(LIBSSH2_SESSION *session,
                           char **errmsg, int *errmsg_len, int want_buf);

🦋 DESCRIPTION 🦋

So here's the vibe check on the args, no cap:

• session — the session instance you got back from libssh2_session_init_ex(3) 🫶
• errmsg — if this isn't NULL, it gets populated by reference with the human readable form of the most recent error message. like, the actual words, not just a number 👑
• errmsg_len — if this isn't NULL, it gets populated by reference with the length of errmsg. and bestie, note this: the string is NUL-terminated, so this length is only useful as an optimization, to avoid calling strlen. it's giving "I already know, why would I count again" 😌
• want_buf — if you set this to a non-zero value, "ownership" of the errmsg buffer gets handed over to the calling scope. and if necessary, the errmsg buffer will be duplicated. so yes, you can keep it, it's yours now 🎀

and what does the whole thing do? it determines the most recent error condition and its cause. that's it. that's the function. iconic behavior honestly 🌈

💀 RETURN VALUE 💀

a numeric error code corresponding to the the Error Code constants. (yes, "the the" — we're keeping it exactly as the original wrote it, fr fr 😭)

heads up: that's a numeric error code, not a string. the string is what lands in errmsg. don't mix them up bestie 🙈

👑 SEE ALSO 👑

• libssh2_session_last_errno(3)
• libssh2_session_set_last_error(3)

and that's the whole page, you ate it 💅✨ this was libssh2 0.15, dated 1 Jun 2007 — yeah she's vintage but she's still serving 🎀🦋 mwah, go catch those errors bestie 💖