summaryrefslogtreecommitdiff
path: root/docs/reference/src/util/nng_version.md
blob: cd6666e31115a3ecf08e846ae050ad66ad8f0469 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# nng_version

## NAME

nng_version --- report library version

## SYNOPSIS

```c
#include <nng/nng.h>

const char * nng_version(void);
```

## DESCRIPTION

The `nng_version()` function returns a human readable {{i:version number}}
for _NNG_.

Additionally, compile time version information is available
via some predefined macros:

- {{i:`NNG_MAJOR_VERSION`}}: Major version number.
- {{i:`NNG_MINOR_VERSION`}}: Minor version number.
- {{i:`NNG_PATCH_VERSION`}}: Patch version number.

_NNG_ is developed and released using
[Semantic Versioning 2.0](http://www.semver.org), and
the version numbers reported refer to both the API and the library itself.
(The {{i:ABI}} -- {{i:application binary interface}} -- between the
library and the application is controlled in a similar, but different
manner depending upon the link options and how the library is built.)

## RETURN VALUES

`NUL`-terminated string containing the library version number.

{{#include ../refs.md}}