libssh2_version(3)

💖 libssh2_version(3) — the libssh2 manual, bestie edition 💖

okay so this is a page from the libssh2 manual, and today's main character is libssh2_version ✨

---

🌸 NAME 🌸

libssh2_version — bestie, it literally just returns the libssh2 version number 💅

---

🎀 SYNOPSIS 🎀

#include <libssh2.h>

const char *
libssh2_version(int required_version);

---

🦋 DESCRIPTION 🦋

okay so here's the tea ☕ if required_version is lower than or equal to the version number of the libssh2 that's actually in use, then boom 💥 you get the version number of libssh2 back, as a pointer to a zero terminated string. iconic behaviour, no notes.

and the required_version you pass in? it should be the version number as constructed by the LIBSSH2_VERSION_NUM define over in the libssh2.h public header file 📄 and that thing is a 24 bit number in the 0xMMmmpp format, periodt. so like:

• MM → major number 👑
• mm → minor number ✨
• pp → patch number 🩹

---

💜 RETURN VALUE 💜

you get the version number of libssh2 back as a pointer to a zero terminated string 🌈 … OR you get NULL if the required_version is not fulfilled 😭 that's it, that's the whole vibe check.

---

🔥 EXAMPLE 🔥

say you wanna make sure you're running with the correct libssh2 version — do this, bestie:

if(!libssh2_version(LIBSSH2_VERSION_NUM)) {
  fprintf(stderr, "Runtime libssh2 version too old.");
  exit(1);
}

and if you just wanna unconditionally get the version number, no gatekeeping, no conditions, just vibes:

printf("libssh2 version: %s", libssh2_version(0));

---

🌈 AVAILABILITY 🌈

this function was added in libssh2 1.1 🫶 and in previous versions there was literally no way to extract this info at run-time. like, none. tragic, honestly. 💀

---

⭐ SEE ALSO ⭐

(this page doesn't list any SEE ALSO references, bestie — it's a short one, we keep it cute 🎀)

---

💀 quick reminder: if required_version isn't fulfilled you get NULL, so fr fr check your return value before you go dereferencing it. your future self will thank you 🫶

---

and that's the whole page!! 💖 this was from the libssh2 manual, page libssh2_version(3), dated 23 Feb 2009 — yeah she's an old queen but she still slays 👑 mwah, bye bestie 🧚✨💜