projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk) |
| 2 | .\" | |
| 93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
| fea681da MK |
4 | .\" Permission is granted to make and distribute verbatim copies of this |
| 5 | .\" manual provided the copyright notice and this permission notice are | |
| 6 | .\" preserved on all copies. | |
| 7 | .\" | |
| 8 | .\" Permission is granted to copy and distribute modified versions of this | |
| 9 | .\" manual under the conditions for verbatim copying, provided that the | |
| 10 | .\" entire resulting derived work is distributed under the terms of a | |
| 11 | .\" permission notice identical to this one. | |
| c13182ef | 12 | .\" |
| fea681da MK |
13 | .\" Since the Linux kernel and libraries are constantly changing, this |
| 14 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
| 15 | .\" responsibility for errors or omissions, or for damages resulting from | |
| 16 | .\" the use of the information contained herein. The author(s) may not | |
| 17 | .\" have taken the same level of care in the production of this manual, | |
| 18 | .\" which is licensed free of charge, as they might when working | |
| 19 | .\" professionally. | |
| c13182ef | 20 | .\" |
| fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
| 22 | .\" the source, must acknowledge the copyright and authors of this work. | |
| 4b72fb64 | 23 | .\" %%%LICENSE_END |
| fea681da MK |
24 | .\" |
| 25 | .\" References consulted: | |
| 26 | .\" Linux libc source code | |
| 27 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
| 28 | .\" 386BSD man pages | |
| 29 | .\" Modified Sat Jul 24 21:25:52 1993 by Rik Faith (faith@cs.unc.edu) | |
| 30 | .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) | |
| 460495ca | 31 | .TH CLOSEDIR 3 2015-08-08 "" "Linux Programmer's Manual" |
| fea681da MK |
32 | .SH NAME |
| 33 | closedir \- close a directory | |
| 34 | .SH SYNOPSIS | |
| 35 | .nf | |
| 36 | .B #include <sys/types.h> | |
| 68e4db0a | 37 | .PP |
| fea681da | 38 | .B #include <dirent.h> |
| 68e4db0a | 39 | .PP |
| 6dea120e | 40 | .BI "int closedir(DIR *" dirp ); |
| fea681da MK |
41 | .fi |
| 42 | .SH DESCRIPTION | |
| 60a90ecd MK |
43 | The |
| 44 | .BR closedir () | |
| 45 | function closes the directory stream associated with | |
| c6fa0841 | 46 | .IR dirp . |
| 7134d7e6 GS |
47 | A successful call to |
| 48 | .BR closedir () | |
| 08eaa638 | 49 | also closes the underlying file descriptor associated with |
| 7134d7e6 | 50 | .IR dirp . |
| c6fa0841 MK |
51 | The directory stream descriptor |
| 52 | .I dirp | |
| 53 | is not available | |
| fea681da | 54 | after this call. |
| 47297adb | 55 | .SH RETURN VALUE |
| 60a90ecd MK |
56 | The |
| 57 | .BR closedir () | |
| 58 | function returns 0 on success. | |
| cca657e2 MK |
59 | On error, \-1 is returned, and |
| 60 | .I errno | |
| 61 | is set appropriately. | |
| fea681da MK |
62 | .SH ERRORS |
| 63 | .TP | |
| 64 | .B EBADF | |
| c6fa0841 MK |
65 | Invalid directory stream descriptor |
| 66 | .IR dirp . | |
| fbbf0faf MS |
67 | .SH ATTRIBUTES |
| 68 | For an explanation of the terms used in this section, see | |
| 69 | .BR attributes (7). | |
| 70 | .TS | |
| 71 | allbox; | |
| 72 | lb lb lb | |
| 73 | l l l. | |
| 74 | Interface Attribute Value | |
| 75 | T{ | |
| 76 | .BR closedir () | |
| 77 | T} Thread safety MT-Safe | |
| 78 | .TE | |
| 47297adb | 79 | .SH CONFORMING TO |
| aa4533ed | 80 | POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD. |
| 47297adb | 81 | .SH SEE ALSO |
| fea681da MK |
82 | .BR close (2), |
| 83 | .BR opendir (3), | |
| 84 | .BR readdir (3), | |
| 85 | .BR rewinddir (3), | |
| 86 | .BR scandir (3), | |
| 87 | .BR seekdir (3), | |
| 88 | .BR telldir (3) |