libzmq/doc/zmq_strerror.adoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

48 lines
1.0 KiB
Plaintext
Raw Normal View History

= zmq_strerror(3)
2010-02-10 16:18:46 +01:00
== NAME
2010-03-09 18:47:31 +01:00
zmq_strerror - get 0MQ error message string
2010-02-10 16:18:46 +01:00
== SYNOPSIS
2010-03-09 18:47:31 +01:00
*const char *zmq_strerror (int 'errnum');*
2010-02-10 16:18:46 +01:00
== DESCRIPTION
2010-03-09 18:47:31 +01:00
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.
2010-02-10 16:18:46 +01:00
== RETURN VALUE
2010-03-09 18:47:31 +01:00
The _zmq_strerror()_ function shall return a pointer to an error message
string.
2010-02-10 16:18:46 +01:00
== ERRORS
2010-02-10 16:18:46 +01:00
No errors are defined.
== EXAMPLE
2010-03-09 18:47:31 +01:00
.Displaying an error message when a 0MQ context cannot be initialised
2010-02-10 16:18:46 +01:00
----
void *ctx = zmq_init (1, 1, 0);
if (!ctx) {
2010-03-09 18:47:31 +01:00
printf ("Error occurred during zmq_init(): %s\n", zmq_strerror (errno));
2010-02-10 16:18:46 +01:00
abort ();
}
----
== SEE ALSO
xref:zmq.adoc[zmq]
2010-02-10 16:18:46 +01:00
== AUTHORS
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.