libssh2_version(3)

libssh2_version3

Return the libssh2 version number

Usage

#include <libssh2.h>
const char *
libssh2_version(int required_version);

Overview

If required_version is lower than or equal to the version number of the libssh2 in use, the version number of libssh2 is returned as a pointer to a zero terminated string.

The required_version should be the version number as constructed by the LIBSSH2_VERSION_NUM define in the libssh2.h public header file, which is a 24 bit number in the 0xMMmmpp format. MM for major, mm for minor and pp for patch number.

Return value

The version number of libssh2 is returned as a pointer to a zero terminated string or NULL if the required_version is not fulfilled.

Examples

To make sure you run with the correct libssh2 version:

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

Unconditionally get the version number:

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

Releases

9 releases since Debian 6.0 (Squeeze); the text changed 2 times.

  1. 6.0
  2. 7–12
  3. 13–Arch

Availability

This function was added in libssh2 1.1, in previous versions there way no way to extract this info in run-time.

From libssh2 1.11.1-7 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.