~ubuntu-branches/ubuntu/saucy/zeromq3/saucy

« back to all changes in this revision

Viewing changes to doc/zmq_strerror.3

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini
  • Date: 2012-06-04 21:21:09 UTC
  • Revision ID: package-import@ubuntu.com-20120604212109-b7b3m0rn21o8oo2q
Tags: upstream-3.1.0~beta+dfsg
ImportĀ upstreamĀ versionĀ 3.1.0~beta+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" t
 
2
.\"     Title: zmq_strerror
 
3
.\"    Author: [see the "AUTHORS" section]
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 12/18/2011
 
6
.\"    Manual: 0MQ Manual
 
7
.\"    Source: 0MQ 3.1.0
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "ZMQ_STRERROR" "3" "12/18/2011" "0MQ 3\&.1\&.0" "0MQ Manual"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
zmq_strerror \- get 0MQ error message string
 
32
.SH "SYNOPSIS"
 
33
.sp
 
34
\fBconst char *zmq_strerror (int \fR\fB\fIerrnum\fR\fR\fB);\fR
 
35
.SH "DESCRIPTION"
 
36
.sp
 
37
The \fIzmq_strerror()\fR function shall return a pointer to an error message string corresponding to the error number specified by the \fIerrnum\fR argument\&. As 0MQ defines additional error numbers over and above those defined by the operating system, applications should use \fIzmq_strerror()\fR in preference to the standard \fIstrerror()\fR function\&.
 
38
.SH "RETURN VALUE"
 
39
.sp
 
40
The \fIzmq_strerror()\fR function shall return a pointer to an error message string\&.
 
41
.SH "ERRORS"
 
42
.sp
 
43
No errors are defined\&.
 
44
.SH "EXAMPLE"
 
45
.PP
 
46
\fBDisplaying an error message when a 0MQ context cannot be initialised\fR. 
 
47
.sp
 
48
.if n \{\
 
49
.RS 4
 
50
.\}
 
51
.nf
 
52
void *ctx = zmq_init (1, 1, 0);
 
53
if (!ctx) {
 
54
    printf ("Error occurred during zmq_init(): %s\en", zmq_strerror (errno));
 
55
    abort ();
 
56
}
 
57
.fi
 
58
.if n \{\
 
59
.RE
 
60
.\}
 
61
.sp
 
62
.SH "SEE ALSO"
 
63
.sp
 
64
\fBzmq\fR(7)
 
65
.SH "AUTHORS"
 
66
.sp
 
67
The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmartin@lucina\&.net\fR\m[]\&\s-2\u[2]\d\s+2>\&.
 
68
.SH "NOTES"
 
69
.IP " 1." 4
 
70
sustrik@250bpm.com
 
71
.RS 4
 
72
\%mailto:sustrik@250bpm.com
 
73
.RE
 
74
.IP " 2." 4
 
75
martin@lucina.net
 
76
.RS 4
 
77
\%mailto:martin@lucina.net
 
78
.RE