diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-23 17:13:02 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-23 17:13:02 -0700 |
| commit | 133c849048ba44e964b3bc4f356a31f347316cd9 (patch) | |
| tree | e12413f20d0a26abfb4398619b0b10d220eba5fe /docs/ref/api/util | |
| parent | 4de579a2617bfa1ee501a1669f3c351511135b2f (diff) | |
| download | nng-133c849048ba44e964b3bc4f356a31f347316cd9.tar.gz nng-133c849048ba44e964b3bc4f356a31f347316cd9.tar.bz2 nng-133c849048ba44e964b3bc4f356a31f347316cd9.zip | |
docs: document error codes
Diffstat (limited to 'docs/ref/api/util')
| -rw-r--r-- | docs/ref/api/util/nng_strerror.md | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/docs/ref/api/util/nng_strerror.md b/docs/ref/api/util/nng_strerror.md deleted file mode 100644 index a48f9f54..00000000 --- a/docs/ref/api/util/nng_strerror.md +++ /dev/null @@ -1,33 +0,0 @@ -# nng_strerror - -## NAME - -nng_strerror --- return an error description - -## SYNOPSIS - -```c -#include <nng/nng.h> - -const char *nng_strerror(int err); -``` - -## DESCRIPTION - -The {{i:`nng_strerror`}} returns the human-readable description of the -given error in `err`. - -The returned {{i: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. |