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.\" Copyright 2021 Oxide Computer Company 47.\" 48.Dd February 25, 2021 49.Dt CLOSEDIR 3C 50.Os 51.Sh NAME 52.Nm closedir 53.Nd close a directory stream 54.Sh SYNOPSIS 55.In sys/types.h 56.In dirent.h 57.Ft int 58.Fo closedir 59.Fa "DIR *dirp" 60.Fc 61.Sh DESCRIPTION 62The 63.Fn closedir 64function closes the directory stream referred to by the argument 65.Fa dirp , 66which generally came from calling 67.Xr opendir 3C 68or 69.Xr fdopendir 3C . 70Upon return, the value of 71.Fa dirp 72will no longer point to an accessible object of the type 73.Ft DIR . 74The underlying file descriptor for the directory stream will be closed. 75This includes a 76.Ft DIR 77created by passing a file descriptor to 78.Xr fdopendir 3C . 79.Pp 80When the directory stream is closed, any memory that is associated with 81the stream will no longer be valid. 82Most notably, the dirent structures returned from 83.Xr readdir 3C 84use memory associated with the corresponding 85.Ft "DIR *" 86argument. 87Each directory stream has its own independent memory. 88Closing one stream does not impact the validity of other streams. 89.Sh RETURN VALUES 90Upon successful completion, the 91.Fn closedir 92function returns 93.Sy 0 . 94Otherwise, 95.Sy -1 96is returned and 97.Va errno 98is set to indicate the error. 99.Sh ERRORS 100The 101.Fn closedir 102function may fail if: 103.Bl -tag -width Er 104.It Er EBADF 105The 106.Fa dirp 107argument does not refer to an open directory stream. 108.It Er EINTR 109The 110.Fn closedir 111function was interrupted by a signal. 112.El 113.Sh INTERFACE STABILITY 114.Sy Standard 115.Sh MT-LEVEL 116.Sy Safe 117.Sh SEE ALSO 118.Xr fdopendir 3C , 119.Xr opendir 3C , 120.Xr readdir 3C , 121.Xr attributes 7 122