diff options
Diffstat (limited to 'upstream/archlinux/man3p/closedir.3p')
-rw-r--r-- | upstream/archlinux/man3p/closedir.3p | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/closedir.3p b/upstream/archlinux/man3p/closedir.3p new file mode 100644 index 00000000..3119103a --- /dev/null +++ b/upstream/archlinux/man3p/closedir.3p @@ -0,0 +1,110 @@ +'\" et +.TH CLOSEDIR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +closedir +\(em close a directory stream +.SH SYNOPSIS +.LP +.nf +#include <dirent.h> +.P +int closedir(DIR *\fIdirp\fP); +.fi +.SH DESCRIPTION +The +\fIclosedir\fR() +function shall close the directory stream referred to by the argument +.IR dirp . +Upon return, the value of +.IR dirp +may no longer point to an accessible object of the type +.BR DIR . +If a file descriptor is used to implement type +.BR DIR , +that file descriptor shall be closed. +.SH "RETURN VALUE" +Upon successful completion, +\fIclosedir\fR() +shall return 0; otherwise, \-1 shall be returned and +.IR errno +set to indicate the error. +.SH ERRORS +The +\fIclosedir\fR() +function may fail if: +.TP +.BR EBADF +The +.IR dirp +argument does not refer to an open directory stream. +.TP +.BR EINTR +The +\fIclosedir\fR() +function was interrupted by a signal. +.LP +.IR "The following sections are informative." +.SH EXAMPLES +.SS "Closing a Directory Stream" +.P +The following program fragment demonstrates how the +\fIclosedir\fR() +function is used. +.sp +.RS 4 +.nf + +\&... + DIR *dir; + struct dirent *dp; +\&... + if ((dir = opendir (".")) == NULL) { +\&... + } +.P + while ((dp = readdir (dir)) != NULL) { +\&... + } +.P + closedir(dir); +\&... +.fi +.P +.RE +.SH "APPLICATION USAGE" +None. +.SH RATIONALE +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIdirfd\fR\^(\|)", +.IR "\fIfdopendir\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<dirent.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version and the original IEEE and +The Open Group Standard, the original IEEE and The Open Group Standard +is the referee document. The original Standard can be obtained online at +http://www.opengroup.org/unix/online.html . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |