lib/libc/gen/closefrom.3

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