Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_version (3ssh2)

Name

libssh2_version - return the libssh2 version number

Synopsis

#include <libssh2.h>

const char * libssh2_version(int required_version);

Description

libssh2_version(3ssh2)          libssh2 manual          libssh2_version(3ssh2)



NAME
       libssh2_version - return the libssh2 version number

SYNOPSIS
       #include <libssh2.h>

       const char * libssh2_version(int required_version);

DESCRIPTION
       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 termi-
       nated string or NULL if the required_version isn't fulfilled.

EXAMPLE
       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) );

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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded   from    https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 1.1                       23 Feb 2009           libssh2_version(3ssh2)