diff options
Diffstat (limited to 'docs/nng_strerror.adoc')
| -rw-r--r-- | docs/nng_strerror.adoc | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/docs/nng_strerror.adoc b/docs/nng_strerror.adoc deleted file mode 100644 index c81a460f..00000000 --- a/docs/nng_strerror.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= nng_strerror(3) -// -// 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 - -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)>> |