summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man3p/fgetpos.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man3p/fgetpos.3p')
-rw-r--r--man-pages-posix-2013/man3p/fgetpos.3p101
1 files changed, 101 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man3p/fgetpos.3p b/man-pages-posix-2013/man3p/fgetpos.3p
new file mode 100644
index 0000000..913d90c
--- /dev/null
+++ b/man-pages-posix-2013/man3p/fgetpos.3p
@@ -0,0 +1,101 @@
+'\" et
+.TH FGETPOS "3P" 2013 "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
+fgetpos
+\(em get current file position information
+.SH SYNOPSIS
+.LP
+.nf
+#include <stdio.h>
+.P
+int fgetpos(FILE *restrict \fIstream\fP, fpos_t *restrict \fIpos\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\(hy2008 defers to the ISO\ C standard.
+.P
+The
+\fIfgetpos\fR()
+function shall store the current values of the parse state (if any)
+and file position indicator for the stream pointed to by
+.IR stream
+in the object pointed to by
+.IR pos .
+The value stored contains unspecified information usable by
+\fIfsetpos\fR()
+for repositioning the stream to its position at the time of the call to
+\fIfgetpos\fR().
+.P
+The
+\fIfgetpos\fR()
+function shall not change the setting of
+.IR errno
+if successful.
+.SH "RETURN VALUE"
+Upon successful completion,
+\fIfgetpos\fR()
+shall return 0; otherwise, it shall return a non-zero value and set
+.IR errno
+to indicate the error.
+.SH ERRORS
+The
+\fIfgetpos\fR()
+function shall fail if:
+.TP
+.BR EBADF
+The file descriptor underlying
+.IR stream
+is not valid.
+.TP
+.BR EOVERFLOW
+The current value of the file position cannot be represented correctly
+in an object of type
+.BR fpos_t .
+.TP
+.BR ESPIPE
+The file descriptor underlying
+.IR stream
+is associated with a pipe, FIFO, or socket.
+.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 "\fIfopen\fR\^(\|)",
+.IR "\fIftell\fR\^(\|)",
+.IR "\fIrewind\fR\^(\|)",
+.IR "\fIungetc\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2008,
+.IR "\fB<stdio.h>\fP"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, Copyright (C) 2013 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/online.html .
+
+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 .