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

« back to all changes in this revision

Viewing changes to doc/zmq_errno.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_errno
 
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_ERRNO" "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_errno \- retrieve value of errno for the calling thread
 
32
.SH "SYNOPSIS"
 
33
.sp
 
34
\fBint zmq_errno (void);\fR
 
35
.SH "DESCRIPTION"
 
36
.sp
 
37
The \fIzmq_errno()\fR function shall retrieve the value of the \fIerrno\fR variable for the calling thread\&.
 
38
.sp
 
39
The \fIzmq_errno()\fR function is provided to assist users on non\-POSIX systems who are experiencing issues with retrieving the correct value of \fIerrno\fR directly\&. Specifically, users on Win32 systems whose application is using a different C run\-time library from the C run\-time library in use by 0MQ will need to use \fIzmq_errno()\fR for correct operation\&.
 
40
.if n \{\
 
41
.sp
 
42
.\}
 
43
.RS 4
 
44
.it 1 an-trap
 
45
.nr an-no-space-flag 1
 
46
.nr an-break-flag 1
 
47
.br
 
48
.ps +1
 
49
\fBImportant\fR
 
50
.ps -1
 
51
.br
 
52
.sp
 
53
Users not experiencing issues with retrieving the correct value of \fIerrno\fR should not use this function and should instead access the \fIerrno\fR variable directly\&.
 
54
.sp .5v
 
55
.RE
 
56
.SH "RETURN VALUE"
 
57
.sp
 
58
The \fIzmq_errno()\fR function shall return the value of the \fIerrno\fR variable for the calling thread\&.
 
59
.SH "ERRORS"
 
60
.sp
 
61
No errors are defined\&.
 
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