summaryrefslogtreecommitdiff
path: root/lib/libc/sys/closefrom.2
blob: b6f767adfc6d090d6c88c462b8591b5b0c10cdd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.\"	$OpenBSD: closefrom.2,v 1.3 2006/05/26 04:41:02 deraadt Exp $
.\"
.\" Copyright (c) 2004 Ted Unangst.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.Dd January 11, 2004
.Dt CLOSEFROM 2
.Os
.Sh NAME
.Nm closefrom
.Nd delete many descriptors
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fn closefrom "int fd"
.Sh DESCRIPTION
The
.Fn closefrom
call deletes all descriptors numbered
.Fa fd
and higher from the per-process file descriptor table.
It is effectively the same as calling
.Xr close 2
on each descriptor.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of \-1 is returned and the global integer variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn closefrom
will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa fd
is greater than all open file descriptors.
.It Bq Er EINTR
An interrupt was received.
.El
.Sh SEE ALSO
.Xr close 2