aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_strerror.adoc
blob: 568f11509b237d98ed1b105bb589776ba300247f (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
47
48
49
50
51
52
53
54
= nng_strerror(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \
            Copyright 2018 Capitar IT Group BV <info@capitar.com> \
            This software 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

nng_strerror - return an error description

== SYNOPSIS

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

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

== DESCRIPTION

The `nng_strerror()` returns the human-readable description of the
given _nng_ error in `err`.

NOTE: The returned error message is provided in US English, but in the
future locale-specific strings may be presented instead.

NOTE: The specific strings associated with specific error messages are
subject to change.  Therefore applications must not depend on the message,
but may use them verbatim when supplying information to end-users, such
as in diagnostic messages or log entries.

== RETURN VALUES

This function returns the human-readable error message, terminated
by a `NUL` byte.

== SEE ALSO

<<libnng#,libnng(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] +
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]

This document is supplied under the terms of the
https://opensource.org/licenses/MIT[MIT License].