summaryrefslogtreecommitdiff
path: root/docs/ref/util/nng_strerror.adoc
blob: 0fc62c823e0887b0f51159954e9650048dcc3977 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
## nng_strerror

Return an error description.

### Synopsis

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

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

### Description

The `nng_strerror` returns the human-readable description of the given error in `err`.footnote:[The error message is provided in US English, but in the future locale-specific strings may be available.]

NOTE: The specific strings associated with specific error codes are subject to change without notice.
Therefore applications must not depend on the message contents, but pass 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.