From 133c849048ba44e964b3bc4f356a31f347316cd9 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Wed, 23 Oct 2024 17:13:02 -0700 Subject: docs: document error codes --- docs/ref/api/util/nng_strerror.md | 33 --------------------------------- 1 file changed, 33 deletions(-) delete mode 100644 docs/ref/api/util/nng_strerror.md (limited to 'docs/ref/api/util') 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 - -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. -- cgit v1.2.3-70-g09d2