Debian Codegraph @

upstream/mageia-cauldron/man3pm/Errno.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Errno 3pm"
61 .TH Errno 3pm 2026-05-26 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Errno \- System errno constants
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Errno qw(EINTR EIO :POSIX);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\f(CW\*(C`Errno\*(C'\fR defines and conditionally exports all the error constants
76 defined in your system \fIerrno.h\fR include file. It has a single export
77 tag, \f(CW\*(C`:POSIX\*(C'\fR, which will export all POSIX defined error numbers.
78 .PP
79 On Windows, \f(CW\*(C`Errno\*(C'\fR also defines and conditionally exports all the
80 Winsock error constants defined in your system \fIWinError.h\fR include
81 file. These are included in a second export tag, \f(CW\*(C`:WINSOCK\*(C'\fR.
82 .PP
83 \&\f(CW\*(C`Errno\*(C'\fR also makes \f(CW\*(C`%!\*(C'\fR magic such that each element of \f(CW\*(C`%!\*(C'\fR has a
84 non\-zero value only if \f(CW$!\fR is set to that value. For example:
85 .PP
86 .Vb 8
87 \& my $fh;
88 \& unless (open($fh, "<", "/fangorn/spouse")) {
89 \& if ($!{ENOENT}) {
90 \& warn "Get a wife!\en";
91 \& } else {
92 \& warn "This path is barred: $!";
93 \& }
94 \& }
95 .Ve
96 .PP
97 If a specified constant \f(CW\*(C`EFOO\*(C'\fR does not exist on the system, \f(CW$!{EFOO}\fR
98 returns \f(CW""\fR. You may use \f(CW\*(C`exists $!{EFOO}\*(C'\fR to check whether the
99 constant is available on the system.
100 .PP
101 Perl automatically loads \f(CW\*(C`Errno\*(C'\fR the first time you use \f(CW\*(C`%!\*(C'\fR, so you don\*(Aqt
102 need an explicit \f(CW\*(C`use\*(C'\fR.
103 .SH CAVEATS
104 .IX Header "CAVEATS"
105 Importing a particular constant may not be very portable, because the
106 import will fail on platforms that do not have that constant. A more
107 portable way to set \f(CW$!\fR to a valid value is to use:
108 .PP
109 .Vb 3
110 \& if (exists &Errno::EFOO) {
111 \& $! = &Errno::EFOO;
112 \& }
113 .Ve
114 .SH AUTHOR
115 .IX Header "AUTHOR"
116 Graham Barr <[email protected]>
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright (c) 1997\-8 Graham Barr. All rights reserved.
120 This program is free software; you can redistribute it and/or modify it
121 under the same terms as Perl itself.