0
0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-27 15:41:05 +08:00
libzmq/doc/zmq_strerror.txt
Martin Lucina 32baeb610e Revert "Various changes to documentation project:"
This reverts commit 77a3c36ff1f11215229a4efdb821a3cb83a9d6fc.
2010-09-04 15:55:11 +02:00

56 lines
1.0 KiB
Plaintext

zmq_strerror(3)
===============
NAME
----
zmq_strerror - get 0MQ error message string
SYNOPSIS
--------
*const char *zmq_strerror (int 'errnum');*
DESCRIPTION
-----------
The _zmq_strerror()_ function shall return a pointer to an error message string
corresponding to the error number specified by the 'errnum' argument. As 0MQ
defines additional error numbers over and above those defined by the operating
system, applications should use _zmq_strerror()_ in preference to the standard
_strerror()_ function.
RETURN VALUE
------------
The _zmq_strerror()_ function shall return a pointer to an error message
string.
ERRORS
------
No errors are defined.
EXAMPLE
-------
.Displaying an error message when a 0MQ context cannot be initialised
----
void *ctx = zmq_init (1, 1, 0);
if (!ctx) {
printf ("Error occurred during zmq_init(): %s\n", zmq_strerror (errno));
abort ();
}
----
SEE ALSO
--------
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.