Debian Codegraph @

upstream/debian-unstable/man3/Errno.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Errno 3perl"
58 .TH Errno 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Errno \- System errno constants
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use Errno qw(EINTR EIO :POSIX);
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 \&\f(CW\*(C`Errno\*(C'\fR defines and conditionally exports all the error constants
73 defined in your system \fIerrno.h\fR include file. It has a single export
74 tag, \f(CW\*(C`:POSIX\*(C'\fR, which will export all POSIX defined error numbers.
75 .PP
76 On Windows, \f(CW\*(C`Errno\*(C'\fR also defines and conditionally exports all the
77 Winsock error constants defined in your system \fIWinError.h\fR include
78 file. These are included in a second export tag, \f(CW\*(C`:WINSOCK\*(C'\fR.
79 .PP
80 \&\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
81 non-zero value only if \f(CW$!\fR is set to that value. For example:
82 .PP
83 .Vb 8
84 \& my $fh;
85 \& unless (open($fh, "<", "/fangorn/spouse")) {
86 \& if ($!{ENOENT}) {
87 \& warn "Get a wife!\en";
88 \& } else {
89 \& warn "This path is barred: $!";
90 \& }
91 \& }
92 .Ve
93 .PP
94 If a specified constant \f(CW\*(C`EFOO\*(C'\fR does not exist on the system, \f(CW$!{EFOO}\fR
95 returns \f(CW""\fR. You may use \f(CW\*(C`exists $!{EFOO}\*(C'\fR to check whether the
96 constant is available on the system.
97 .PP
98 Perl automatically loads \f(CW\*(C`Errno\*(C'\fR the first time you use \f(CW\*(C`%!\*(C'\fR, so you don't
99 need an explicit \f(CW\*(C`use\*(C'\fR.
100 .SH CAVEATS
101 .IX Header "CAVEATS"
102 Importing a particular constant may not be very portable, because the
103 import will fail on platforms that do not have that constant. A more
104 portable way to set \f(CW$!\fR to a valid value is to use:
105 .PP
106 .Vb 3
107 \& if (exists &Errno::EFOO) {
108 \& $! = &Errno::EFOO;
109 \& }
110 .Ve
111 .SH AUTHOR
112 .IX Header "AUTHOR"
113 Graham Barr <[email protected]>
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright (c) 1997\-8 Graham Barr. All rights reserved.
117 This program is free software; you can redistribute it and/or modify it
118 under the same terms as Perl itself.