diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/rewinddir.3p | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/rewinddir.3p')
-rw-r--r-- | upstream/archlinux/man3p/rewinddir.3p | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/rewinddir.3p b/upstream/archlinux/man3p/rewinddir.3p new file mode 100644 index 00000000..9b40280c --- /dev/null +++ b/upstream/archlinux/man3p/rewinddir.3p @@ -0,0 +1,93 @@ +'\" et +.TH REWINDDIR "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 +rewinddir +\(em reset the position of a directory stream to the beginning +of a directory +.SH SYNOPSIS +.LP +.nf +#include <dirent.h> +.P +void rewinddir(DIR *\fIdirp\fP); +.fi +.SH DESCRIPTION +The +\fIrewinddir\fR() +function shall reset the position of the directory stream to which +.IR dirp +refers to the beginning of the directory. It shall also cause the +directory stream to refer to the current state of the corresponding +directory, as a call to +\fIopendir\fR() +would have done. If +.IR dirp +does not refer to a directory stream, the effect is undefined. +.P +After a call to the +\fIfork\fR() +function, either the parent or child (but not both) may continue +processing the directory stream using +\fIreaddir\fR(), +\fIrewinddir\fR(), +or +\fIseekdir\fR(). +If both the parent and child processes use these functions, the result +is undefined. +.SH "RETURN VALUE" +The +\fIrewinddir\fR() +function shall not return a value. +.SH ERRORS +No errors are defined. +.LP +.IR "The following sections are informative." +.SH EXAMPLES +None. +.SH "APPLICATION USAGE" +The +\fIrewinddir\fR() +function should be used in conjunction with +\fIopendir\fR(), +\fIreaddir\fR(), +and +\fIclosedir\fR() +to examine the contents of the directory. This method is recommended +for portability. +.SH RATIONALE +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIclosedir\fR\^(\|)", +.IR "\fIfdopendir\fR\^(\|)", +.IR "\fIreaddir\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<dirent.h>\fP", +.IR "\fB<sys_types.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 . |