gwyversion

gwyversion — Version information

Functions

gint gwy_version_major ()
gint gwy_version_minor ()
const gchar * gwy_version_string ()

Types and Values

Includes

#include <libgwyddion/gwyddion.h>

Description

Macros like GWY_VERSION_MAJOR can be used for compile-time version checks, that is they tell what version a module or app is being compiled or was compiled with.

On the other hand functions like gwy_version_major() can be used to run-time version checks and they tell what version a module or app was linked or is running with.

Functions

gwy_version_major()

gint
gwy_version_major (void);

Gets the major version of Gwyddion.

If the version is 1.99.7.20060604, this function returns 1.

The function provides run-time version information. See GWY_VERSON_MAJOR for compile-time version information.

Returns

The major version.


gwy_version_minor()

gint
gwy_version_minor (void);

Gets the minor version of Gwyddion.

If the version is 1.99.7.20060604, this function returns 99.

The function provides run-time version information. See GWY_VERSON_MINOR for compile-time version information.

Returns

The minor version.


gwy_version_string()

const gchar *
gwy_version_string (void);

Gets the full Gwyddion version as a string.

If the version is 1.99.7.20060604, this function returns "1.99.7.20060604".

The function provides run-time version information. See GWY_VERSON_STRING for compile-time version information.

This is the only method to get finer version information than major.minor. However, only development versions use finer versioning than major.minor. Therefore, a module or program requiring such information is probably broken anyway. A meaningful use is to advertise the version of Gwyddion libraries your program runs with.

Returns

The full version as a constant string.

Types and Values

GWY_VERSION_MAJOR

#define GWY_VERSION_MAJOR 3

Expands to the major version of Gwyddion as a number.

If the version is 1.99.7.20060604, this macro is defined as 1.

The macro provides compile-time version information. See gwy_version_major() for run-time version information.


GWY_VERSION_MINOR

#define GWY_VERSION_MINOR 2

Expands to the minor version of Gwyddion as a number.

If the version is 1.99.7.20060604, this macro is defined as 99.

The macro provides compile-time version information. See gwy_version_minor() for run-time version information.


GWY_VERSION_STRING

#define GWY_VERSION_STRING "3.2"

Expands to the full Gwyddion version as a string.

If the version is 1.99.7.20060604, this macro is defined as "1.99.7.20060604".

The macro provides compile-time version information. See gwy_version_major() for run-time version information. Also see gwy_version_string() for caveats. A meaningful use of this macro might perhaps be to advertise the version of Gwyddion libraries your program was compiled with.