summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/rewind.3p
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3p/rewind.3p')
-rw-r--r--upstream/archlinux/man3p/rewind.3p102
1 files changed, 102 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/rewind.3p b/upstream/archlinux/man3p/rewind.3p
new file mode 100644
index 00000000..7e966719
--- /dev/null
+++ b/upstream/archlinux/man3p/rewind.3p
@@ -0,0 +1,102 @@
+'\" et
+.TH REWIND "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
+rewind
+\(em reset the file position indicator in a stream
+.SH SYNOPSIS
+.LP
+.nf
+#include <stdio.h>
+.P
+void rewind(FILE *\fIstream\fP);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
+.P
+The call:
+.sp
+.RS 4
+.nf
+
+rewind(stream)
+.fi
+.P
+.RE
+.P
+shall be equivalent to:
+.sp
+.RS 4
+.nf
+
+(void) fseek(stream, 0L, SEEK_SET)
+.fi
+.P
+.RE
+.P
+except that
+\fIrewind\fR()
+shall also clear the error indicator.
+.P
+Since
+\fIrewind\fR()
+does not return a value, an application wishing to detect errors should
+clear
+.IR errno ,
+then call
+\fIrewind\fR(),
+and if
+.IR errno
+is non-zero, assume an error has occurred.
+.SH "RETURN VALUE"
+The
+\fIrewind\fR()
+function shall not return a value.
+.SH ERRORS
+Refer to
+.IR "\fIfseek\fR\^(\|)"
+with the exception of
+.BR [EINVAL]
+which does not apply.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+None.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "Section 2.5" ", " "Standard I/O Streams",
+.IR "\fIfseek\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<stdio.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 .