usr/src/man/man3c/closedir.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
  46 .\"
  47 .TH CLOSEDIR 3C "Jul 24, 2002"
  48 .SH NAME
  49 closedir \- close a directory stream
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <sys/types.h>
  54 #include <dirent.h>
  55
  56 \fBint\fR \fBclosedir\fR(\fBDIR *\fR\fIdirp\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBclosedir()\fR function closes the directory stream referred to by the
  63 argument \fIdirp.\fR Upon return, the value of \fIdirp\fR may no longer point
  64 to an accessible object of the type \fBDIR\fR. If a file descriptor is used to
  65 implement type \fBDIR\fR, that file descriptor will be closed.
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 Upon successful completion, \fBclosedir()\fR returns \fB0\fR. Otherwise,
  70 \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBclosedir()\fR function may fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEBADF\fR\fR
  79 .ad
  80 .RS 9n
  81 The \fIdirp\fR argument does not refer to an open directory stream.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEINTR\fR\fR
  88 .ad
  89 .RS 9n
  90 The \fBclosedir()\fR function was interrupted by a signal.
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Standard
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBopendir\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)