summaryrefslogtreecommitdiff
path: root/docs/man/nn_strerror.3compat.adoc
blob: 090a012a6490dd394d301b66fe43a13e93c8467c (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
39
40
41
42
43
44
45
46
= nn_errno(3compat)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt).  A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//

== NAME

nn_strerror - return message for error (compatible API)

== SYNOPSIS

[source,c]
----
#include <nanomsg/nn.h>

const char *nn_strerror(int err);
----

== DESCRIPTION

The `nn_strerror()` function returns a human readable message corresponding
to the given error number _err_.

NOTE: This function is provided for API
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
Consider using the relevant <<libnng.3#,modern API>> instead.

== RETURN VALUES

This function returns the message corresponding to _err_.

== ERRORS

None.

== SEE ALSO

<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>